Distribution Service Api 1.0.0

Server

/api/v1.0/

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

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

Authentication

oauth2 oauth2

FlowClient Credentials

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

Platforms

Get a list of available platforms

Auth

Required Scopes:get:platforms

Query String

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

GET /platforms

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//platforms' \ --header 'Authorization: Bearer {token}' \ --data name={name} \ --data use_case={use_case} \ --data account_id={account_id} \ --data product_id={product_id}
Copy

Responses

200

Successfully returned a list of platforms

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

Response

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

Create a new platform

Auth

Required Scopes:post:platforms

Request Body

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

POST /platforms

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//platforms' \ --header 'Authorization: Bearer {token}' \ --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

Create a new platform

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

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

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

/destinations/template

GET

/destinations/example

DELETE

/destinations/{destination_id}/delete

Get a list of active destinations for a platform

Auth

Required Scopes:get:destinations

Query String

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

GET /destinations

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//destinations' \ --header 'Authorization: Bearer {token}' \ --data external_id={external_id} \ --data platform_name={platform_name} \ --data use_case={use_case} \ --data customer_id={customer_id} \ --data account_id={account_id} \ --data product_id={product_id} \ --data adara_destination_id={adara_destination_id} \ --data internal_id={internal_id} \ --data active=true
Copy

Responses

200

Successfully returned a list of destinations

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

400

Invalid request format

Response

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

Auth

Required Scopes:post:destinations

Request Body

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

POST /destinations

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//destinations' \ --header 'Authorization: Bearer {token}' \ --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

Create a destination

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive
response	object
created	integer	unix timestamp of when the destination was create in seconds
destination_id	string	unique id for the destination

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

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

Get required attributes for creating a new destination

Auth

Required Scopes:get:destinations/template

Query String

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

GET /destinations/template

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//destinations/template' \ --header 'Authorization: Bearer {token}' \ --data platform_name={platform_name} \ --data use_case={use_case}
Copy

Responses

200

Successfully returned the required attributes

object	object
active	boolean
response	object

Response

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

Get required attributes for creating a new destination

Auth

Required Scopes:get:destinations/template

Query String

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

GET /destinations/example

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//destinations/example' \ --header 'Authorization: Bearer {token}' \ --data platform_name={platform_name} \ --data use_case={use_case}
Copy

Responses

200

Successfully returned the required attributes

object	object
active	boolean
response	object

Response

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

delete

Delete a destination

Auth

Required Scopes:delete:destinations

Path Params

destination_id string

Query String

platform_name	string
use_case	string

DELETE /destinations/{destination_id}/delete

xxxxxxxxxx
 
curl --request DELETE \ --url '/api/v1.0//destinations/523af537946b79c4f8369ed39ba78605/delete' \ --header 'Authorization: Bearer {token}' \ --data platform_name={platform_name} \ --data use_case={use_case}
Copy

Responses

200

Destination Deleted

object	object
response	array[object]
success	boolean

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

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

Segments

/segments/{segment_id}/delete

POST

/segments/bulk_delete

Get a list of available segments for a destination

Auth

Required Scopes:get:segments

Query String

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

GET /segments

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//segments' \ --header 'Authorization: Bearer {token}' \ --data platform_name={platform_name} \ --data use_case={use_case} \ --data external_id={external_id} \ --data internal_id={internal_id} \ --data destination_id={destination_id} \ --data adara_segment_id={adara_segment_id} \ --data audience_id={audience_id} \ --data account_id={account_id} \ --data product_id={product_id} \ --data active=true
Copy

Responses

200

Successfully rdeturned a list of segments

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

Response

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

Auth

Required Scopes:post:segments

Request Body

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

POST /segments

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//segments' \ --header 'Authorization: Bearer {token}' \ --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

Create a Segment

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive
response	object
created	integer	unix timestamp of when the destination was create in seconds
segment_id	string	unique id for the segment

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

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

Get required attributes for creating a new segment

Auth

Required Scopes:get:segments/template

Query String

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

GET /segments/template

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//segments/template' \ --header 'Authorization: Bearer {token}' \ --data platform_name={platform_name} \ --data use_case={use_case}
Copy

Responses

200

Successfully returned the required attributes

object	object
active	boolean
response	object

Response

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

Get required attributes for creating a new segment

Auth

Required Scopes:get:segments/template

Query String

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

GET /segments/example

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//segments/example' \ --header 'Authorization: Bearer {token}' \ --data platform_name={platform_name} \ --data use_case={use_case}
Copy

Responses

200

Successfully returned the required attributes

object	object
active	boolean
response	object

Response

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

delete

Delete the segments for the destination

Auth

Required Scopes:delete:segments

Path Params

segment_id string

Query String

destination_id	string
platform_name	string
use_case	string

DELETE /segments/{segment_id}/delete

xxxxxxxxxx
 
curl --request DELETE \ --url '/api/v1.0//segments/523af537946b79c4f8369ed39ba78605/delete' \ --header 'Authorization: Bearer {token}' \ --data destination_id={destination_id} \ --data platform_name={platform_name} \ --data use_case={use_case}
Copy

Responses

200

Successfully returned a boolean value

object	object
response	array[object]
success	boolean

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

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

bulk_delete

Delete the segments for the destination

Auth

Required Scopes:delete:destinations

Request Body

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

POST /segments/bulk_delete

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

Responses

200

Destination Deleted

object	object
response	array[object]
success	boolean

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

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

Distributions

POST

/distributions

Push defined audience to third party platforms

Auth

Required Scopes:post:distributions

Request Body

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

POST /distributions

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//distributions' \ --header 'Authorization: Bearer {token}' \ --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

Job Created

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive
response	object
created	integer	unix timestamp of file delivery time in seconds
job_id	string	unique id for the request

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

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

Audience_sizes

POST

/audience_sizes/search

Get activated audience delivered size

Auth

Required Scopes:get:audience_sizes

Request Body

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

POST /audience_sizes/search

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//audience_sizes/search' \ --header 'Authorization: Bearer {token}' \ --data '{  "platform_name": "google_ads",  "use_case": "audience_management",  "segment_id": "0cc175b9c0f1b6a831c399e269772661",  "from_date": "2019-12-01",  "to_date": "2019-12-31"}'
Copy

Responses

200

Successfully returned the delivered audience size

object	object
active	boolean
response	array[object]
platform_name	string
use_case	string	Enum: `managed_services`,`audience_management`,`marketplace`
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

Expand

401

Missing/Invalid/Expired Authorization Token

Response

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