Distribution Service Api1.0.0

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/

Authentication

oauth2 oauth2

FlowclientCredentials

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

Platforms

Get a list of available platforms

GET /platforms

Auth

Query String

name	string		optional
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	optional
account_id	string		optional
product_id	string		optional

Example Request

​x
 
curl --request GET \ --url /api/v1.0//platforms?name={name}&use_case={use_case}&account_id={account_id}&product_id={product_id}
Copy

Responses

200

object	object
active	boolean	optional
response	array[object]	optional
name	string	optional
display_name	string	optional
image_url	string	optional
use_cases	array[string]	optional

Example Response

200 Successfully returned a list of platforms

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "name": "dv360",   "display_name": "dv360",   "image_url": "{string}",   "use_cases": [    "managed_services",    "audience_management",    "marketplace"   ]  } ]}
Copy

Create a new platform

POST /platforms

Auth

Request Body

object	object	required
name	string	required
display_name	string	required
product_ids	array[string]	optional
account_ids	array[string]	optional
use_cases	array[string]	required
url_domain	object	required
qa	string	required
prod	string	required
api_version	object	required
qa	string	required
prod	string	required
image_details	object	required
bucket_name	string	required
file_path	string	required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//platforms \ --data '{  "name": "dv360",  "display_name": "dv360",  "product_ids": [    "{array[string]...}"  ],  "account_ids": [    "{array[string]...}"  ],  "use_cases": [    "managed_services",    "audience_management",    "marketplace"  ],  "url_domain": {    "qa": "https://facebook-qa.adara.com",    "prod": "https://facebook-prod.adara.com"  },  "api_version": {    "qa": "v1.0",    "prod": "v1.0"  },  "image_details": {    "bucket_name": "{string}",    "file_path": "{string}"  }}'
Copy

Responses

200 400 401

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive	optional
response	object		optional
name	string		required
display_name	string		required
product_ids	array[string]		optional
account_ids	array[string]		optional
use_cases	array[string]		required
url_domain	object		required
qa	string		required
prod	string		required
api_version	object		required
qa	string		required
prod	string		required
active	boolean		required
image_url	string		required
created	integer		required
updated	integer		required

Example Response

200 Create a new platform

400 Invalid request format

401 Missing/Invalid/Expired Authorization Token

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "name": "dv360",  "display_name": "dv360",  "product_ids": [   "{array[string]...}"  ],  "account_ids": [   "{array[string]...}"  ],  "use_cases": [   "managed_services",   "audience_management",   "marketplace"  ],  "url_domain": {   "qa": "https://facebook-qa.adara.com",   "prod": "https://facebook-prod.adara.com"  },  "api_version": {   "qa": "v1.0",   "prod": "v1.0"  },  "active": "{boolean}",  "image_url": "{string}",  "created": "{integer}",  "updated": "{integer}" }}
Copy

Destinations

Get a list of active destinations for a platform

GET /destinations

Auth

Query String

external_id	string		optional
platform_name	string		optional
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	optional
customer_id	string		optional
account_id	string		optional
product_id	string		optional
adara_destination_id	string		optional
internal_id	string		optional
active	boolean	Default: true	optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//destinations?external_id={external_id}&platform_name={platform_name}&use_case={use_case}&customer_id={customer_id}&account_id={account_id}&product_id={product_id}&adara_destination_id={adara_destination_id}&internal_id={internal_id}&active=true
Copy

Responses

200 400

object	object
active	boolean		optional
response	array		optional
name	string		required
platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required
external_id	string		optional
advertiser_id	string		optional
partner_id	string		optional
parent_id	string		optional
extra_attributes	object		optional
id	string		optional
created	integer		optional
updated	integer		optional
active	boolean		optional

Example Response

200 Successfully returned a list of destinations

400 Invalid request format

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "name": "Adara Media",   "platform_name": "dv360",   "use_case": "{string}",   "external_id": "e079b430",   "advertiser_id": 2020,   "partner_id": 2020,   "parent_id": "dse4t4f",   "extra_attributes": {}  } ]}
Copy

Create a new destination on a platform

POST /destinations

Auth

Request Body

object	object		required
name	string		required
platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required
external_id	string		optional
advertiser_id	string		optional
partner_id	string		optional
parent_id	string		optional
extra_attributes	object		optional

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//destinations \ --data '{  "name": "Adara Media",  "platform_name": "dv360",  "use_case": "{string}",  "external_id": "e079b430",  "advertiser_id": 2020,  "partner_id": 2020,  "parent_id": "dse4t4f",  "extra_attributes": {}}'
Copy

Responses

200 400 401

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive	optional
response	object		optional
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

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "created": "{integer}",  "destination_id": "{string}" }}
Copy

Get required attributes for creating a new destination

GET /destinations/template

Auth

Query String

platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//destinations/template?platform_name={platform_name}&use_case={use_case}
Copy

Responses

200

object	object
active	boolean	optional
response	object	optional

Example Response

200 Successfully returned the required attributes

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {}}
Copy

Get required attributes for creating a new destination

GET /destinations/example

Auth

Query String

platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//destinations/example?platform_name={platform_name}&use_case={use_case}
Copy

Responses

200

object	object
active	boolean	optional
response	object	optional

Example Response

200 Successfully returned the required attributes

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {}}
Copy

delete

DELETE /destinations/{destination_id}/delete

Delete a destination

Auth

Path Params

destination_id string required

Query String

platform_name	string		required
use_case	string		required

Example Request

xxxxxxxxxx
 
curl --request DELETE \ --url /api/v1.0//destinations/{destination_id}/delete?platform_name={platform_name}&use_case={use_case}
Copy

Responses

200 400 401

object	object
response	array[object]	optional
success	boolean	optional

Example Response

200 Destination Deleted

400 Invalid request format

401 Missing/Invalid/Expired Authorization Token

xxxxxxxxxx
 
{ "response": [  {   "success": true  } ]}
Copy

Segments

Get a list of available segments for a destination

GET /segments

Auth

Query String

platform_name	string		optional
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	optional
external_id	string		optional
internal_id	string		optional
destination_id	string		optional
adara_segment_id	string		optional
audience_id	string		optional
account_id	string		optional
product_id	string		optional
active	boolean	Default: true	optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//segments?platform_name={platform_name}&use_case={use_case}&external_id={external_id}&internal_id={internal_id}&destination_id={destination_id}&adara_segment_id={adara_segment_id}&audience_id={audience_id}&account_id={account_id}&product_id={product_id}&active=true
Copy

Responses

200

object	object
active	boolean		optional
response	array		optional
name	string		required
destination_id	string		optional
external_id	string		optional
metadata	object		optional
rate	number		optional
rate_type	string		optional
currency	string		optional
extra_attributes	object		optional
platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required
account_id	string		optional
product_id	string		optional
expiration	integer	maximum: 31 minimum: 1	required
id	string		optional
created	integer		optional
updated	integer		optional
active	boolean		optional
size	integer		optional

Example Response

200 Successfully rdeturned a list of segments

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "name": "High Value Travelers",   "destination_id": "de938affb1775a3de079b438bdadf00b",   "external_id": "ehf834ff2",   "metadata": {},   "rate": 3.15,   "rate_type": "cpm",   "currency": "USD",   "extra_attributes": {},   "platform_name": "dv360",   "use_case": "{string}",   "account_id": "{string}",   "product_id": "{string}",   "expiration": 14  } ]}
Copy

Create a new segment for a destination

POST /segments

Auth

Request Body

object	object		required
name	string		required
destination_id	string		optional
external_id	string		optional
metadata	object		optional
rate	number		optional
rate_type	string		optional
currency	string		optional
extra_attributes	object		optional
platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required
account_id	string		optional
product_id	string		optional
expiration	integer	maximum: 31 minimum: 1	required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//segments \ --data '{  "name": "High Value Travelers",  "destination_id": "de938affb1775a3de079b438bdadf00b",  "external_id": "ehf834ff2",  "metadata": {},  "rate": 3.15,  "rate_type": "cpm",  "currency": "USD",  "extra_attributes": {},  "platform_name": "dv360",  "use_case": "{string}",  "account_id": "{string}",  "product_id": "{string}",  "expiration": 14}'
Copy

Responses

200 400 401

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive	optional
response	object		optional
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

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "created": "{integer}",  "segment_id": "{string}" }}
Copy

Get required attributes for creating a new segment

GET /segments/template

Auth

Query String

platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//segments/template?platform_name={platform_name}&use_case={use_case}
Copy

Responses

200

object	object
active	boolean	optional
response	object	optional

Example Response

200 Successfully returned the required attributes

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {}}
Copy

Get required attributes for creating a new segment

GET /segments/example

Auth

Query String

platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//segments/example?platform_name={platform_name}&use_case={use_case}
Copy

Responses

200

object	object
active	boolean	optional
response	object	optional

Example Response

200 Successfully returned the required attributes

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {}}
Copy

delete

DELETE /segments/{segment_id}/delete

Delete the segments for the destination

Auth

Path Params

segment_id string required

Query String

destination_id	string	required
platform_name	string	required
use_case	string	required

Example Request

xxxxxxxxxx
 
curl --request DELETE \ --url /api/v1.0//segments/{segment_id}/delete?destination_id={destination_id}&platform_name={platform_name}&use_case={use_case}
Copy

Responses

200 400 401

object	object
response	array[object]	optional
success	boolean	optional

Example Response

200 Successfully returned a boolean value

400 Invalid request format

401 Missing/Invalid/Expired Authorization Token

xxxxxxxxxx
 
{ "response": [  {   "success": true  } ]}
Copy

bulk_delete

POST /segments/bulk_delete

Delete the segments for the destination

Auth

Request Body

object	object	required
destination_id	string	required
platform_name	string	required
use_case	string	optional
delete_all	boolean	optional
segments	array[string]	required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//segments/bulk_delete \ --data '{  "destination_id": "523af537946b79c4f8369ed39ba78605",  "platform_name": "dv360",  "use_case": "managed_services",  "delete_all": "{boolean}",  "segments": [    "0cc175b9c0f1b6a831c399e269772661"  ]}'
Copy

Responses

200 400 401

object	object
response	array[object]	optional
success	boolean	optional

Example Response

200 Destination Deleted

400 Invalid request format

401 Missing/Invalid/Expired Authorization Token

xxxxxxxxxx
 
{ "response": [  {   "success": true  } ]}
Copy

Distributions

Push defined audience to third party platforms

POST /distributions

Auth

Request Body

object	object		required
platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required
approved_dp_ids	array[integer]		optional
segments	array		required
bucket	string		required
files	array[string]		required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//distributions \ --data '{  "platform_name": "dv360",  "use_case": "{string}",  "approved_dp_ids": [    900,    1020  ],  "segments": [    {      "bucket": "dot-sandbox-test",      "files": [        "output/dv360_02272019.csv",        "output/dv360_*.csv"      ]    }  ]}'
Copy

Responses

200 400 401

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive	optional
response	object		optional
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

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "created": "{integer}",  "job_id": "{string}" }}
Copy

Audience_sizes

Get activated audience delivered size

POST /audience_sizes/search

Auth

Request Body

object	object		required
platform_name	string		optional
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	optional
segment_id	string		required
from_date	string		optional
to_date	string		optional

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//audience_sizes/search
Copy

Responses

200 401

object	object
active	boolean		optional
response	array[object]		optional
platform_name	string		required
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`	required
audience_id	string		optional
account_id	string		optional
destination_id	string		optional
segment_id	string		required
created	integer		required
audience_size	integer		optional
translated_audience_size	integer		optional
new_ids	integer		optional
translated_new_ids	integer		optional
stale_ids	integer		optional
translated_stale_ids	integer		optional
scheduled_additions	integer		optional
translated_scheduled_additions	integer		optional
scheduled_deletions	integer		optional
translated_scheduled_deletions	integer		optional
delivered_ids	integer		optional
translated_delivered_ids	integer		optional
removed_ids	integer		optional
translated_removed_ids	integer		optional
expired_ids	integer		optional
translated_expired_ids	integer		optional
active_ids	integer		optional
translated_active_ids	integer		optional

Example Response

200 Successfully returned the delivered audience size

401 Missing/Invalid/Expired Authorization Token

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "platform_name": "google_ads",   "use_case": "{string}",   "audience_id": "{string}",   "account_id": "{string}",   "destination_id": "{string}",   "segment_id": "{string}",   "created": "{integer}",   "audience_size": "{integer}",   "translated_audience_size": "{integer}",   "new_ids": "{integer}",   "translated_new_ids": "{integer}",   "stale_ids": "{integer}",   "translated_stale_ids": "{integer}",   "scheduled_additions": "{integer}",   "translated_scheduled_additions": "{integer}",   "scheduled_deletions": "{integer}",   "translated_scheduled_deletions": "{integer}",   "delivered_ids": "{integer}",   "translated_delivered_ids": "{integer}",   "removed_ids": "{integer}",   "translated_removed_ids": "{integer}",   "expired_ids": "{integer}",   "translated_expired_ids": "{integer}",   "active_ids": "{integer}",   "translated_active_ids": "{integer}"  } ]}
Copy