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/

Authentication

oauth2 oauth2

FlowClient Credentials

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

Deliveries

Get complete delivery details from the registry

Auth

Required Scopes:get:deliveries

Path Params

id string

GET /deliveries/{id}

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//deliveries/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully returned complete delivery details

object	object
response	object
message	string	Success message indicating that the operation is successful
delivery_details	object
platform_name	string	name of the platform
use_case	string	use case Enum: `audience_management`,`managed_services`,`marketplace`
schedule_start	date	scheduled delivery start date
schedule_end	date	scheduled delivery end date
execution_frequency	string	scheduled delivery execution frequency Enum: `Daily`,`Weekly`,`Bi-Weekly`,`Monthly`
segments		list of segment details
object	object	audience details of the segment
audience_id	string	unique id for the audience
dp_ids	array[integer]	data partner ids provided by DRM Service for a particular consumer and platform
query_id	string	unique id for the query maxLength: 20 minLength: 20
parameters	object	Parameter values referred in the query statement
delivery_id	string	unique id for the delivery
expired	boolean	status flag indicating that the delivery schedule has been expired
last_run	integer	timestamp when the delivery is last run
next_run	integer	timestamp when the delivery should run next
created	integer	timestamp when the delivery is created
updated	integer	most recent timestamp when the delivery is updated
active	boolean	feature flag indicating that the feature endpoint is interactive

Expand

404

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

Response

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

id string

Request Body

destination_id	string	unique id for the destination Deprecated
account_id	string	unique id for the account
customer_id	string	unique id for the customer
platform_name	string	name of the platform
use_case	string	use case Enum: `audience_management`,`managed_services`,`marketplace`
product_id	string	unique id for the product
schedule_start	date	scheduled delivery start date
schedule_end	date	scheduled delivery end date
execution_frequency	string	scheduled delivery execution frequency Enum: `Daily`,`Weekly`,`Bi-Weekly`,`Monthly`
segments		list of segment details
object	object	audience details of the segment
audience_id	string	unique id for the audience
dp_ids	array[integer]	data partner ids provided by DRM Service for a particular consumer and platform
query_id	string	unique id for the query maxLength: 20 minLength: 20
parameters	object	Parameter values referred in the query statement

PUT /deliveries/{id}

xxxxxxxxxx
 
curl --request PUT \ --url '/api/v1.0//deliveries/%7Bid%7D' \ --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

object	object
response	object
message	string	Success message indicating that the operation is successful
delivery_details	object
platform_name	string	name of the platform
use_case	string	use case Enum: `audience_management`,`managed_services`,`marketplace`
schedule_start	date	scheduled delivery start date
schedule_end	date	scheduled delivery end date
execution_frequency	string	scheduled delivery execution frequency Enum: `Daily`,`Weekly`,`Bi-Weekly`,`Monthly`
segments		list of segment details
object	object	audience details of the segment
audience_id	string	unique id for the audience
dp_ids	array[integer]	data partner ids provided by DRM Service for a particular consumer and platform
query_id	string	unique id for the query maxLength: 20 minLength: 20
parameters	object	Parameter values referred in the query statement
delivery_id	string	unique id for the delivery
expired	boolean	status flag indicating that the delivery schedule has been expired
last_run	integer	timestamp when the delivery is last run
next_run	integer	timestamp when the delivery should run next
created	integer	timestamp when the delivery is created
updated	integer	most recent timestamp when the delivery is updated
active	boolean	feature flag indicating that the feature endpoint is interactive

Expand

404

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

Response

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

id string

DELETE /deliveries/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url '/api/v1.0//deliveries/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully de-activated the delivery in the registry

object	object
response	object
message	string	Success message indicating that the operation is successful
active	boolean	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

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

page

integer

Default: 1

GET /deliveries

xxxxxxxxxx
 
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

object	object
response	array[object]
platform_name	string	name of the platform
use_case	string	use case Enum: `audience_management`,`managed_services`,`marketplace`
schedule_start	date	scheduled delivery start date
schedule_end	date	scheduled delivery end date
execution_frequency	string	scheduled delivery execution frequency Enum: `Daily`,`Weekly`,`Bi-Weekly`,`Monthly`
segments		list of segment details
object	object	audience details of the segment
audience_id	string	unique id for the audience
dp_ids	array[integer]	data partner ids provided by DRM Service for a particular consumer and platform
query_id	string	unique id for the query maxLength: 20 minLength: 20
parameters	object	Parameter values referred in the query statement
delivery_id	string	unique id for the delivery
expired	boolean	status flag indicating that the delivery schedule has been expired
last_run	integer	timestamp when the delivery is last run
next_run	integer	timestamp when the delivery should run next
created	integer	timestamp when the delivery is created
updated	integer	most recent timestamp when the delivery is updated
active	boolean	feature flag indicating that the feature endpoint is interactive

Expand

400

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

Response

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

object	object
platform_name	string	name of the platform
use_case	string	use case Enum: `audience_management`,`managed_services`,`marketplace`
schedule_start	date	scheduled delivery start date
schedule_end	date	scheduled delivery end date
execution_frequency	string	scheduled delivery execution frequency Enum: `Daily`,`Weekly`,`Bi-Weekly`,`Monthly`
segments		list of segment details
object	object	audience details of the segment
audience_id	string	unique id for the audience
dp_ids	array[integer]	data partner ids provided by DRM Service for a particular consumer and platform
query_id	string	unique id for the query maxLength: 20 minLength: 20
parameters	object	Parameter values referred in the query statement

POST /deliveries

xxxxxxxxxx
 
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

object	object
response	object
message	string	Success message indicating that the operation is successful
delivery_details	object
platform_name	string	name of the platform
use_case	string	use case Enum: `audience_management`,`managed_services`,`marketplace`
schedule_start	date	scheduled delivery start date
schedule_end	date	scheduled delivery end date
execution_frequency	string	scheduled delivery execution frequency Enum: `Daily`,`Weekly`,`Bi-Weekly`,`Monthly`
segments		list of segment details
object	object	audience details of the segment
audience_id	string	unique id for the audience
dp_ids	array[integer]	data partner ids provided by DRM Service for a particular consumer and platform
query_id	string	unique id for the query maxLength: 20 minLength: 20
parameters	object	Parameter values referred in the query statement
delivery_id	string	unique id for the delivery
expired	boolean	status flag indicating that the delivery schedule has been expired
last_run	integer	timestamp when the delivery is last run
next_run	integer	timestamp when the delivery should run next
created	integer	timestamp when the delivery is created
updated	integer	most recent timestamp when the delivery is updated
active	boolean	feature flag indicating that the feature endpoint is interactive

Expand

400

Failed to add new delivery to the registry

Response

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

/history/{id}

Get execution history of a delivery from the registry

Auth

Required Scopes:get:history

Path Params

id string

Query String

status

string

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

Default: all

sort

string

Enum: DESCENDING,ASCENDING

Default: DESCENDING

created_date string

GET /history/{id}

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//history/%7Bid%7D' \ --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

object	object
response	object
message	string	Success message indicating that the operation is successful
response	array[object]	execution history of a delivery
job_id	string	unique job id for the delivery execeution request
status	string	job status
promises	array[object]	list of promise details
promise_id	string	unique job id for the promise of a delivery execeution request
external_id	string	unique job id for the delivery execeution request
service	string	external service name
status	string	job status
parameters	object	task parameters
results	object	promise results
created	integer	timestamp when the promise is created
updated	integer	most recent timestamp when the promise is updated
results	object	job results
created	integer	timestamp when the job is created
updated	integer	most recent timestamp when the job is updated
active	boolean	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

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

POST

/run

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

Auth

Required Scopes:post:run

Query String

id string

POST /run

xxxxxxxxxx
 
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

object	object
response	object
created	integer	unix timestamp when a job for delivery execution is created
job_id	string	unique job id for the delivery execution request
active	boolean	feature flag indicating that the feature endpoint is interactive

400

Failed to execute the delivery

Response

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