Delivery Coordinator API
Authentication
Deliveries
GETGet complete delivery details from the registry
PUTUpdate an existing delivery in the registry
DELETEDe-activate a delivery in the registry
GETGet the paginated list of details of all the deliveries stored in the registry
POSTAdd a new delivery to the registry
History
GETGet execution history of a delivery from the registry
Run
POSTExecute query segment of the scheduled delivery from registry and deliver results as defined

Delivery Coordinator API 1.0.0

Server
/api/v1.0/
https://delivery-coordinator-qa.adara.com/api/v1.0/
https://delivery-coordinator-prod.adara.com/api/v1.0/
Server Variables

Authentication

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

Get complete delivery details from the registry

Auth
Required Scopes:get:deliveries
Path Params
idstring
GET /deliveries/{id}
curl --get \
--url '/api/v1.0//deliveries/{id}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200

Successfully returned complete delivery details

objectobject
response2 fieldsobject
activeboolean

feature flag indicating that the feature endpoint is interactive

404

Failed to fetch complete delivery details since it was not found in the registry

Response
{
"response": {
"message": "{string}",
"delivery_details": {
"platform_name": "{string}",
"use_case": "{string}",
"schedule_start": "{date}",
"schedule_end": "{date}",
"execution_frequency": "{string}",
"segments": [
{
"audience_id": "{string}",
"dp_ids": [
"{array[integer]...}"
],
"query_id": "{string}",
"parameters": {}
}
],
"delivery_id": "{string}",
"expired": "{boolean}",
"last_run": "{integer}",
"next_run": "{integer}",
"created": "{integer}",
"updated": "{integer}"
}
},
"active": "{boolean}"
}
Copy

Update an existing delivery in the registry

Auth
Required Scopes:put:deliveries
Path Params
idstring
Request Body
destination_idstring

unique id for the destination

Deprecated

account_idstring

unique id for the account

customer_idstring

unique id for the customer

platform_namestring

name of the platform

use_casestring

use case

Enum: audience_management,managed_services,marketplace

product_idstring

unique id for the product

schedule_startdate

scheduled delivery start date

schedule_enddate

scheduled delivery end date

execution_frequencystring

scheduled delivery execution frequency

Enum: Daily,Weekly,Bi-Weekly,Monthly

segments

list of segment details

objectobject

audience details of the segment

audience_idstring

unique id for the audience

dp_idsarray[integer]

data partner ids provided by DRM Service for a particular consumer and platform

query_idstring

unique id for the query

maxLength: 20

minLength: 20

parametersobject

Parameter values referred in the query statement

PUT /deliveries/{id}
curl --request PUT \
--url '/api/v1.0//deliveries/{id}' \
--header 'Authorization: Bearer {token}' \
--data '{
"destination_id": "523af537946b79c4f8369ed39ba78605",
"platform_name": "dv360",
"use_case": "audience_management",
"schedule_start": "2017-07-21",
"schedule_end": "2017-08-21",
"execution_frequency": "Daily",
"segments": [
{
"audience_id": "231"
},
{
"delete": true,
"audience_id": "231"
},
{
"audience_id": "231",
"dp_ids": [
1021,
3400
]
},
{
"audience_id": "231",
"query_id": "iqF6FLyFTXT77nrnRAje",
"parameters": {
"remote_addr": 1145275707
}
},
{
"segment_id": "0cc175b9c0f1b6a831c399e269772661",
"query_id": "iqF6FLyFTXT77nrnRAje",
"parameters": {
"remote_addr": 1145275707
}
},
{
"delete": true,
"segment_id": "0cc175b9c0f1b6a831c399e269772661"
}
]
}'
Copy
Responses
200

Successfully updated the delivery in the registry

objectobject
response2 fieldsobject
activeboolean

feature flag indicating that the feature endpoint is interactive

404

Failed to update the delivery since it was not found in the registry

Response
{
"response": {
"message": "{string}",
"delivery_details": {
"platform_name": "{string}",
"use_case": "{string}",
"schedule_start": "{date}",
"schedule_end": "{date}",
"execution_frequency": "{string}",
"segments": [
{
"audience_id": "{string}",
"dp_ids": [
"{array[integer]...}"
],
"query_id": "{string}",
"parameters": {}
}
],
"delivery_id": "{string}",
"expired": "{boolean}",
"last_run": "{integer}",
"next_run": "{integer}",
"created": "{integer}",
"updated": "{integer}"
}
},
"active": "{boolean}"
}
Copy

De-activate a delivery in the registry

Auth
Required Scopes:delete:deliveries
Path Params
idstring
DELETE /deliveries/{id}
curl --request DELETE \
--url '/api/v1.0//deliveries/{id}' \
--header 'Authorization: Bearer {token}'
Copy
Responses
200

Successfully de-activated the delivery in the registry

objectobject
responseobject
messagestring

Success message indicating that the operation is successful

activeboolean

feature flag indicating that the feature endpoint is interactive

404

Failed to de-activate the delivery since it was not found in the registry

Response
{
"response": {
"message": "{string}"
},
"active": "{boolean}"
}
Copy

Get the paginated list of details of all the deliveries stored in the registry

Auth
Required Scopes:get:deliveries
Query String
pageinteger

Default: 1

GET /deliveries
curl --get \
--url '/api/v1.0//deliveries' \
--header 'Authorization: Bearer {token}' \
--data page=1
Copy
Responses
200

Successfully returned the paginated list of details of all the deliveries stored in the registry

objectobject
responsearray[object]
activeboolean

feature flag indicating that the feature endpoint is interactive

400

Failed to fetch the paginated list of details of all the queries stored in the registry

Response
{
"response": [
{
"platform_name": "{string}",
"use_case": "{string}",
"schedule_start": "{date}",
"schedule_end": "{date}",
"execution_frequency": "{string}",
"segments": [
{
"audience_id": "{string}",
"dp_ids": [
"{array[integer]...}"
],
"query_id": "{string}",
"parameters": {}
}
],
"delivery_id": "{string}",
"expired": "{boolean}",
"last_run": "{integer}",
"next_run": "{integer}",
"created": "{integer}",
"updated": "{integer}"
}
],
"active": "{boolean}"
}
Copy

Add a new delivery to the registry

Auth
Required Scopes:post:deliveries
Request Body
objectobject
platform_namestring

name of the platform

use_casestring

use case

Enum: audience_management,managed_services,marketplace

schedule_startdate

scheduled delivery start date

schedule_enddate

scheduled delivery end date

execution_frequencystring

scheduled delivery execution frequency

Enum: Daily,Weekly,Bi-Weekly,Monthly

segments

list of segment details

objectobject

audience details of the segment

audience_idstring

unique id for the audience

dp_idsarray[integer]

data partner ids provided by DRM Service for a particular consumer and platform

query_idstring

unique id for the query

maxLength: 20

minLength: 20

parametersobject

Parameter values referred in the query statement

POST /deliveries
curl --request POST \
--url '/api/v1.0//deliveries' \
--header 'Authorization: Bearer {token}' \
--data '{
"destination_id": "523af537946b79c4f8369ed39ba78605",
"platform_name": "dv360",
"use_case": "audience_management",
"schedule_start": "2017-07-21",
"schedule_end": "2017-08-21",
"execution_frequency": "Daily",
"segments": [
{
"audience_id": "231"
},
{
"audience_id": "231",
"dp_ids": [
1021,
3400
]
},
{
"audience_id": "231",
"query_id": "iqF6FLyFTXT77nrnRAje",
"parameters": {
"remote_addr": 1145275707
}
},
{
"segment_id": "0cc175b9c0f1b6a831c399e269772661",
"query_id": "iqF6FLyFTXT77nrnRAje",
"parameters": {
"remote_addr": 1145275707
}
}
]
}'
Copy
Responses
200

Successfully added new delivery to the registry

objectobject
response2 fieldsobject
activeboolean

feature flag indicating that the feature endpoint is interactive

400

Failed to add new delivery to the registry

Response
{
"response": {
"message": "{string}",
"delivery_details": {
"platform_name": "{string}",
"use_case": "{string}",
"schedule_start": "{date}",
"schedule_end": "{date}",
"execution_frequency": "{string}",
"segments": [
{
"audience_id": "{string}",
"dp_ids": [
"{array[integer]...}"
],
"query_id": "{string}",
"parameters": {}
}
],
"delivery_id": "{string}",
"expired": "{boolean}",
"last_run": "{integer}",
"next_run": "{integer}",
"created": "{integer}",
"updated": "{integer}"
}
},
"active": "{boolean}"
}
Copy

History

Get execution history of a delivery from the registry

Auth
Required Scopes:get:history
Path Params
idstring
Query String
statusstring

Enum: pending,active,failed,completed,resolved,all

Default: all

sortstring

Enum: DESCENDING,ASCENDING

Default: DESCENDING

created_datestring
GET /history/{id}
curl --get \
--url '/api/v1.0//history/{id}' \
--header 'Authorization: Bearer {token}' \
--data status=all \
--data sort=DESCENDING \
--data created_date={created_date}
Copy
Responses
200

Successfully returned execution history of a delivery

objectobject
response2 fieldsobject
activeboolean

feature flag indicating that the feature endpoint is interactive

404

Failed to fetch execution history of the delivery since it was not found in the registry

Response
{
"response": {
"message": "{string}",
"response": [
{
"job_id": "{string}",
"status": "{string}",
"promises": [
{
"promise_id": "{string}",
"external_id": "{string}",
"service": "{string}",
"status": "{string}",
"parameters": {},
"results": {},
"created": "{integer}",
"updated": "{integer}"
}
],
"results": {},
"created": "{integer}",
"updated": "{integer}"
}
]
},
"active": "{boolean}"
}
Copy

Run

Execute query segment of the scheduled delivery from registry and deliver results as defined

Auth
Required Scopes:post:run
Query String
idstring
POST /run
curl --request POST \
--url '/api/v1.0//run' \
--header 'Authorization: Bearer {token}' \
--data id={id}
Copy
Responses
200

job id for the delivery execeution request is returned

objectobject
responseobject
createdinteger

unix timestamp when a job for delivery execution is created

job_idstring

unique job id for the delivery execution request

activeboolean

feature flag indicating that the feature endpoint is interactive

400

Failed to execute the delivery

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

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