Choose a server to use:
name | string | optional | |
use_case | string | Enum: | optional |
account_id | string | optional | |
product_id | string | optional |
curl --request GET \
--url /api/v1.0//platforms?name={name}&use_case={use_case}&account_id={account_id}&product_id={product_id}
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 |
xxxxxxxxxx
{
"active": "{boolean}",
"response": [
{
"name": "dv360",
"display_name": "dv360",
"image_url": "{string}",
"use_cases": [
"managed_services",
"audience_management",
"marketplace"
]
}
]
}
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 |
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}"
}
}'
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 |
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}"
}
}
external_id | string | optional | |
platform_name | string | optional | |
use_case | string | Enum: | 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 |
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
object | object | ||
active | boolean | optional | |
response | array | optional | |
name | string | required | |
platform_name | string | required | |
use_case | string | Enum: | 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 |
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": {}
}
]
}
object | object | required | |
name | string | required | |
platform_name | string | required | |
use_case | string | Enum: | required |
external_id | string | optional | |
advertiser_id | string | optional | |
partner_id | string | optional | |
parent_id | string | optional | |
extra_attributes | object | optional |
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": {}
}'
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 |
xxxxxxxxxx
{
"active": "{boolean}",
"response": {
"created": "{integer}",
"destination_id": "{string}"
}
}
platform_name | string | required | |
use_case | string | Enum: | required |
xxxxxxxxxx
curl --request GET \
--url /api/v1.0//destinations/template?platform_name={platform_name}&use_case={use_case}
object | object | ||
active | boolean | optional | |
response | object | optional |
xxxxxxxxxx
{
"active": "{boolean}",
"response": {}
}
platform_name | string | required | |
use_case | string | Enum: | required |
xxxxxxxxxx
curl --request GET \
--url /api/v1.0//destinations/example?platform_name={platform_name}&use_case={use_case}
object | object | ||
active | boolean | optional | |
response | object | optional |
xxxxxxxxxx
{
"active": "{boolean}",
"response": {}
}
Delete a destination
destination_id | string | required |
platform_name | string | required | |
use_case | string | required |
xxxxxxxxxx
curl --request DELETE \
--url /api/v1.0//destinations/{destination_id}/delete?platform_name={platform_name}&use_case={use_case}
object | object | ||
response | array[object] | optional | |
success | boolean | optional |
xxxxxxxxxx
{
"response": [
{
"success": true
}
]
}
platform_name | string | optional | |
use_case | string | Enum: | 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 |
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
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: | 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 |
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
}
]
}
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: | required |
account_id | string | optional | |
product_id | string | optional | |
expiration | integer | maximum: 31 minimum: 1 | required |
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
}'
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 |
xxxxxxxxxx
{
"active": "{boolean}",
"response": {
"created": "{integer}",
"segment_id": "{string}"
}
}
platform_name | string | required | |
use_case | string | Enum: | required |
xxxxxxxxxx
curl --request GET \
--url /api/v1.0//segments/template?platform_name={platform_name}&use_case={use_case}
object | object | ||
active | boolean | optional | |
response | object | optional |
xxxxxxxxxx
{
"active": "{boolean}",
"response": {}
}
platform_name | string | required | |
use_case | string | Enum: | required |
xxxxxxxxxx
curl --request GET \
--url /api/v1.0//segments/example?platform_name={platform_name}&use_case={use_case}
object | object | ||
active | boolean | optional | |
response | object | optional |
xxxxxxxxxx
{
"active": "{boolean}",
"response": {}
}
Delete the segments for the destination
segment_id | string | required |
destination_id | string | required | |
platform_name | string | required | |
use_case | string | required |
xxxxxxxxxx
curl --request DELETE \
--url /api/v1.0//segments/{segment_id}/delete?destination_id={destination_id}&platform_name={platform_name}&use_case={use_case}
object | object | ||
response | array[object] | optional | |
success | boolean | optional |
xxxxxxxxxx
{
"response": [
{
"success": true
}
]
}
Delete the segments for the destination
object | object | required | |
destination_id | string | required | |
platform_name | string | required | |
use_case | string | optional | |
delete_all | boolean | optional | |
segments | array[string] | required |
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"
]
}'
object | object | ||
response | array[object] | optional | |
success | boolean | optional |
xxxxxxxxxx
{
"response": [
{
"success": true
}
]
}
object | object | required | |
platform_name | string | required | |
use_case | string | Enum: | required |
approved_dp_ids | array[integer] | optional | |
segments | array | required | |
bucket | string | required | |
files | array[string] | required |
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"
]
}
]
}'
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 |
xxxxxxxxxx
{
"active": "{boolean}",
"response": {
"created": "{integer}",
"job_id": "{string}"
}
}
object | object | required | |
platform_name | string | optional | |
use_case | string | Enum: | optional |
segment_id | string | required | |
from_date | string | optional | |
to_date | string | optional |
xxxxxxxxxx
curl --request POST \
--url /api/v1.0//audience_sizes/search
object | object | ||
active | boolean | optional | |
response | array[object] | optional | |
platform_name | string | required | |
use_case | string | Enum: | 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 |
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}"
}
]
}