Distribution Service Api
Authentication
Platforms
GETGet a list of available platforms
POSTCreate a new platform
Destinations
GETGet a list of active destinations for a platform
POSTCreate a new destination on a platform
GETGet required attributes for creating a new destination
GETGet required attributes for creating a new destination
DELETEdelete
Segments
GETGet a list of available segments for a destination
POSTCreate a new segment for a destination
GETGet required attributes for creating a new segment
GETGet required attributes for creating a new segment
DELETEdelete
POSTbulk_delete
Distributions
POSTPush defined audience to third party platforms
Audience_sizes
POSTGet activated audience delivered size

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/
Server Variables

Authentication

oauth2 oauth2
FlowClient Credentials
Token URL/core/v1.0/oauth/token

Get a list of available platforms

Auth
Required Scopes:get:platforms
Query String
namestring
use_casestring

Enum: managed_services,audience_management,marketplace

account_idstring
product_idstring
GET /platforms
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

objectobject
activeboolean
response4 fieldsarray[object]
Response
{
"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
objectobject
namestring
display_namestring
product_idsarray[string]
account_idsarray[string]
use_casesarray[string]
url_domainobject
qastring
prodstring
api_versionobject
qastring
prodstring
image_detailsobject
bucket_namestring
file_pathstring
POST /platforms
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

objectobject
activeboolean

feature flag indicating that the feature endpoint is interactive

response11 fieldsobject
400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response
{
"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

Get a list of active destinations for a platform

Auth
Required Scopes:get:destinations
Query String
external_idstring
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

customer_idstring
account_idstring
product_idstring
adara_destination_idstring
internal_idstring
activeboolean

Default: true

GET /destinations
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

objectobject
activeboolean
responsearray
400

Invalid request format

Response
{
"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
objectobject
namestring
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

external_idstring
advertiser_idstring
partner_idstring
parent_idstring
extra_attributesobject
POST /destinations
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

objectobject
activeboolean

feature flag indicating that the feature endpoint is interactive

responseobject
createdinteger

unix timestamp of when the destination was create in seconds

destination_idstring

unique id for the destination

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response
{
"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_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

GET /destinations/template
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

objectobject
activeboolean
responseobject
Response
{
"active": "{boolean}",
"response": {}
}
Copy

Get required attributes for creating a new destination

Auth
Required Scopes:get:destinations/template
Query String
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

GET /destinations/example
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

objectobject
activeboolean
responseobject
Response
{
"active": "{boolean}",
"response": {}
}
Copy

delete

Delete a destination

Auth
Required Scopes:delete:destinations
Path Params
destination_idstring
Query String
platform_namestring
use_casestring
DELETE /destinations/{destination_id}/delete
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

objectobject
responsearray[object]
successboolean
400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

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

Get a list of available segments for a destination

Auth
Required Scopes:get:segments
Query String
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

external_idstring
internal_idstring
destination_idstring
adara_segment_idstring
audience_idstring
account_idstring
product_idstring
activeboolean

Default: true

GET /segments
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

objectobject
activeboolean
responsearray
Response
{
"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
objectobject
namestring
destination_idstring
external_idstring
metadataobject
ratenumber
rate_typestring
currencystring
extra_attributesobject
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

account_idstring
product_idstring
expirationinteger

maximum: 31

minimum: 1

POST /segments
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

objectobject
activeboolean

feature flag indicating that the feature endpoint is interactive

responseobject
createdinteger

unix timestamp of when the destination was create in seconds

segment_idstring

unique id for the segment

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response
{
"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_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

GET /segments/template
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

objectobject
activeboolean
responseobject
Response
{
"active": "{boolean}",
"response": {}
}
Copy

Get required attributes for creating a new segment

Auth
Required Scopes:get:segments/template
Query String
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

GET /segments/example
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

objectobject
activeboolean
responseobject
Response
{
"active": "{boolean}",
"response": {}
}
Copy

delete

Delete the segments for the destination

Auth
Required Scopes:delete:segments
Path Params
segment_idstring
Query String
destination_idstring
platform_namestring
use_casestring
DELETE /segments/{segment_id}/delete
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

objectobject
responsearray[object]
successboolean
400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

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

bulk_delete

Delete the segments for the destination

Auth
Required Scopes:delete:destinations
Request Body
objectobject
destination_idstring
platform_namestring
use_casestring
delete_allboolean
segmentsarray[string]
POST /segments/bulk_delete
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

objectobject
responsearray[object]
successboolean
400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

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

Distributions

Push defined audience to third party platforms

Auth
Required Scopes:post:distributions
Request Body
objectobject
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

approved_dp_idsarray[integer]
segmentsarray
bucketstring
filesarray[string]
POST /distributions
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

objectobject
activeboolean

feature flag indicating that the feature endpoint is interactive

responseobject
createdinteger

unix timestamp of file delivery time in seconds

job_idstring

unique id for the request

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

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

Audience_sizes

Get activated audience delivered size

Auth
Required Scopes:get:audience_sizes
Request Body
objectobject
platform_namestring
use_casestring

Enum: managed_services,audience_management,marketplace

segment_idstring
from_datestring
to_datestring
POST /audience_sizes/search
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

objectobject
activeboolean
response25 fieldsarray[object]
401

Missing/Invalid/Expired Authorization Token

Response
{
"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

We serve cookies on this site to analyse traffic and optimise your experience. By using the website you agree to the Privacy Policy.