Delivery Coordinator API1.0.0

Servers

Choose a server to use:

/api/v1.0/

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

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

Authentication

oauth2 oauth2

FlowclientCredentials

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

Deliveries

Get complete delivery details from the registry

GET /deliveries/{id}

Auth

Path Params

id string required

Example Request

​x
 
curl --request GET \ --url /api/v1.0//deliveries/{id}
Copy

Responses

200 404

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

Example Response

200 Successfully returned complete delivery details

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

xxxxxxxxxx
 
{ "response": {  "message": "{string}",  "delivery_details": {   "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

PUT /deliveries/{id}

Auth

Path Params

id string required

Request Body

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

Example Request

xxxxxxxxxx
 
curl --request PUT \ --url /api/v1.0//deliveries/{id} \ --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 404

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

Example Response

200 Successfully updated the delivery in the registry

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

xxxxxxxxxx
 
{ "response": {  "message": "{string}",  "delivery_details": {   "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

DELETE /deliveries/{id}

Auth

Path Params

id string required

Example Request

xxxxxxxxxx
 
curl --request DELETE \ --url /api/v1.0//deliveries/{id}
Copy

Responses

200 404

object	object
response	object		optional
message	string	Success message indicating that the operation is successful	optional
active	boolean	feature flag indicating that the feature endpoint is interactive	optional

Example Response

200 Successfully de-activated the delivery in the registry

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

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

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

GET /deliveries

Auth

Query String

page

integer

Default: 1

required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//deliveries?page=1
Copy

Responses

200 400

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

Example Response

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

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

xxxxxxxxxx
 
{ "response": [  {   "platform_name": "{string}",   "use_case": "{string}",   "schedule_start": "{string}",   "schedule_end": "{string}",   "execution_frequency": "{string}",   "segments": [    "{array...}"   ]  } ], "active": "{boolean}"}
Copy

Add a new delivery to the registry

POST /deliveries

Auth

Request Body

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

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//deliveries \ --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 400

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

Example Response

200 Successfully added new delivery to the registry

400 Failed to add new delivery to the registry

xxxxxxxxxx
 
{ "response": {  "message": "{string}",  "delivery_details": {   "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

GET /history/{id}

Auth

Path Params

id string required

Query String

status

string

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

Default: all

required

sort

string

Enum: DESCENDING,ASCENDING

Default: DESCENDING

required

created_date string optional

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1.0//history/{id}?status=all&sort=DESCENDING&created_date={created_date}
Copy

Responses

200 404

object	object
response	object		optional
message	string	Success message indicating that the operation is successful	optional
response	array[object]	execution history of a delivery	optional
job_id	string	unique job id for the delivery execeution request	optional
status	string	job status	optional
promises	array[object]	list of promise details	optional
promise_id	string	unique job id for the promise of a delivery execeution request	optional
external_id	string	unique job id for the delivery execeution request	optional
service	string	external service name	optional
status	string	job status	optional
parameters	object	task parameters	optional
results	object	promise results	optional
created	integer	timestamp when the promise is created	optional
updated	integer	most recent timestamp when the promise is updated	optional
results	object	job results	optional
created	integer	timestamp when the job is created	optional
updated	integer	most recent timestamp when the job is updated	optional
active	boolean	feature flag indicating that the feature endpoint is interactive	optional

Example Response

200 Successfully returned execution history of a delivery

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

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

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

POST /run

Auth

Query String

id string required

Example Request

xxxxxxxxxx
 
curl --request POST \ --url /api/v1.0//run?id={id}
Copy

Responses

200 400

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

Example Response

200 job id for the delivery execeution request is returned

400 Failed to execute the delivery

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