v3.0
Distribution Service Api

Servers

Choose a server to use:

/api/v1.0/
https://distribution-qa.adara.com/api/v1.0/
https://distribution-prod.adara.com/api/v1.0/
oauth2 oauth2

FlowclientCredentials
Token URL/core/v1.0/oauth/token

Get a list of available platforms

GET /platforms

Auth
Query String
name stringoptional
use_case string

Enum: managed_services,audience_management,marketplace

optional
account_id stringoptional
product_id stringoptional
Example Request
Copy
Responses
200
object object
active booleanoptional
response array[object]optional
name stringoptional
display_name stringoptional
image_url stringoptional
use_cases array[string]optional
Example Response
200 Successfully returned a list of platforms
Copy

Create a new platform

POST /platforms

Auth
Request Body
object objectrequired
name stringrequired
display_name stringrequired
product_ids array[string]optional
account_ids array[string]optional
use_cases array[string]required
url_domain objectrequired
qa stringrequired
prod stringrequired
api_version objectrequired
qa stringrequired
prod stringrequired
image_details objectrequired
bucket_name stringrequired
file_path stringrequired
Example Request
Copy
Responses
200 400 401
object object
active boolean

feature flag indicating that the feature endpoint is interactive

optional
response objectoptional
name stringrequired
display_name stringrequired
product_ids array[string]optional
account_ids array[string]optional
use_cases array[string]required
url_domain objectrequired
qa stringrequired
prod stringrequired
api_version objectrequired
qa stringrequired
prod stringrequired
active booleanrequired
image_url stringrequired
created integerrequired
updated integerrequired
Example Response
200 Create a new platform
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
Copy

Get a list of active destinations for a platform

GET /destinations

Auth
Query String
external_id stringoptional
platform_name stringoptional
use_case string

Enum: managed_services,audience_management,marketplace

optional
customer_id stringoptional
account_id stringoptional
product_id stringoptional
adara_destination_id stringoptional
internal_id stringoptional
active boolean

Default: true

optional
Example Request
Copy
Responses
200 400
object object
active booleanoptional
response arrayoptional
name stringrequired
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
external_id stringoptional
advertiser_id stringoptional
partner_id stringoptional
parent_id stringoptional
extra_attributes objectoptional
id stringoptional
created integeroptional
updated integeroptional
active booleanoptional
Example Response
200 Successfully returned a list of destinations
400 Invalid request format
Copy

Create a new destination on a platform

POST /destinations

Auth
Request Body
object objectrequired
name stringrequired
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
external_id stringoptional
advertiser_id stringoptional
partner_id stringoptional
parent_id stringoptional
extra_attributes objectoptional
Example Request
Copy
Responses
200 400 401
object object
active boolean

feature flag indicating that the feature endpoint is interactive

optional
response objectoptional
created integer

unix timestamp of when the destination was create in seconds

optional
destination_id string

unique id for the destination

optional
Example Response
200 Create a destination
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
Copy

Get required attributes for creating a new destination

GET /destinations/template

Auth
Query String
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
Example Request
Copy
Responses
200
object object
active booleanoptional
response objectoptional
Example Response
200 Successfully returned the required attributes
Copy

Get required attributes for creating a new destination

GET /destinations/example

Auth
Query String
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
Example Request
Copy
Responses
200
object object
active booleanoptional
response objectoptional
Example Response
200 Successfully returned the required attributes
Copy

delete

DELETE /destinations/{destination_id}/delete

Delete a destination

Auth
Path Params
destination_id stringrequired
Query String
platform_name stringrequired
use_case stringrequired
Example Request
Copy
Responses
200 400 401
object object
response array[object]optional
success booleanoptional
Example Response
200 Destination Deleted
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
Copy

Get a list of available segments for a destination

GET /segments

Auth
Query String
platform_name stringoptional
use_case string

Enum: managed_services,audience_management,marketplace

optional
external_id stringoptional
internal_id stringoptional
destination_id stringoptional
adara_segment_id stringoptional
audience_id stringoptional
account_id stringoptional
product_id stringoptional
active boolean

Default: true

optional
Example Request
Copy
Responses
200
object object
active booleanoptional
response arrayoptional
name stringrequired
destination_id stringoptional
external_id stringoptional
metadata objectoptional
rate numberoptional
rate_type stringoptional
currency stringoptional
extra_attributes objectoptional
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
account_id stringoptional
product_id stringoptional
expiration integer

maximum: 31

minimum: 1

required
id stringoptional
created integeroptional
updated integeroptional
active booleanoptional
size integeroptional
Example Response
200 Successfully rdeturned a list of segments
Copy

Create a new segment for a destination

POST /segments

Auth
Request Body
object objectrequired
name stringrequired
destination_id stringoptional
external_id stringoptional
metadata objectoptional
rate numberoptional
rate_type stringoptional
currency stringoptional
extra_attributes objectoptional
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
account_id stringoptional
product_id stringoptional
expiration integer

maximum: 31

minimum: 1

required
Example Request
Copy
Responses
200 400 401
object object
active boolean

feature flag indicating that the feature endpoint is interactive

optional
response objectoptional
created integer

unix timestamp of when the destination was create in seconds

optional
segment_id string

unique id for the segment

optional
Example Response
200 Create a Segment
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
Copy

Get required attributes for creating a new segment

GET /segments/template

Auth
Query String
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
Example Request
Copy
Responses
200
object object
active booleanoptional
response objectoptional
Example Response
200 Successfully returned the required attributes
Copy

Get required attributes for creating a new segment

GET /segments/example

Auth
Query String
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
Example Request
Copy
Responses
200
object object
active booleanoptional
response objectoptional
Example Response
200 Successfully returned the required attributes
Copy

delete

DELETE /segments/{segment_id}/delete

Delete the segments for the destination

Auth
Path Params
segment_id stringrequired
Query String
destination_id stringrequired
platform_name stringrequired
use_case stringrequired
Example Request
Copy
Responses
200 400 401
object object
response array[object]optional
success booleanoptional
Example Response
200 Successfully returned a boolean value
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
Copy

bulk_delete

POST /segments/bulk_delete

Delete the segments for the destination

Auth
Request Body
object objectrequired
destination_id stringrequired
platform_name stringrequired
use_case stringoptional
delete_all booleanoptional
segments array[string]required
Example Request
Copy
Responses
200 400 401
object object
response array[object]optional
success booleanoptional
Example Response
200 Destination Deleted
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
Copy

Distributions

Push defined audience to third party platforms

POST /distributions

Auth
Request Body
object objectrequired
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
approved_dp_ids array[integer]optional
segments arrayrequired
bucket stringrequired
files array[string]required
Example Request
Copy
Responses
200 400 401
object object
active boolean

feature flag indicating that the feature endpoint is interactive

optional
response objectoptional
created integer

unix timestamp of file delivery time in seconds

optional
job_id string

unique id for the request

optional
Example Response
200 Job Created
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
Copy

Audience_sizes

Get activated audience delivered size

POST /audience_sizes/search

Auth
Request Body
object objectrequired
platform_name stringoptional
use_case string

Enum: managed_services,audience_management,marketplace

optional
segment_id stringrequired
from_date stringoptional
to_date stringoptional
Example Request
Copy
Responses
200 401
object object
active booleanoptional
response array[object]optional
platform_name stringrequired
use_case string

Enum: managed_services,audience_management,marketplace

required
audience_id stringoptional
account_id stringoptional
destination_id stringoptional
segment_id stringrequired
created integerrequired
audience_size integeroptional
translated_audience_size integeroptional
new_ids integeroptional
translated_new_ids integeroptional
stale_ids integeroptional
translated_stale_ids integeroptional
scheduled_additions integeroptional
translated_scheduled_additions integeroptional
scheduled_deletions integeroptional
translated_scheduled_deletions integeroptional
delivered_ids integeroptional
translated_delivered_ids integeroptional
removed_ids integeroptional
translated_removed_ids integeroptional
expired_ids integeroptional
translated_expired_ids integeroptional
active_ids integeroptional
translated_active_ids integeroptional
Example Response
200 Successfully returned the delivered audience size
401 Missing/Invalid/Expired Authorization Token
Copy