Deliveries
Get complete delivery details from the registry
| id | string |
xxxxxxxxxxcurl --get \ --url '/api/v1.0//deliveries/%7Bid%7D' \ --header 'Authorization: Bearer {token}'Successfully returned complete delivery details
| object | object | ||
| response | object | ||
| message | string | Success message indicating that the operation is successful | |
| delivery | object | ||
| platform | string | name of the platform | |
| use | string | use case Enum: | |
| schedule | date | scheduled delivery start date | |
| schedule | date | scheduled delivery end date | |
| execution | string | scheduled delivery execution frequency Enum: | |
| segments | list of segment details | ||
| object | object | audience details of the segment | |
| audience | string | unique id for the audience | |
| dp | array[integer] | data partner ids provided by DRM Service for a particular consumer and platform | |
| query | string | unique id for the query maxLength: 20 minLength: 20 | |
| parameters | object | Parameter values referred in the query statement | |
| delivery | string | unique id for the delivery | |
| expired | boolean | status flag indicating that the delivery schedule has been expired | |
| last | integer | timestamp when the delivery is last run | |
| next | 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 |
Failed to fetch complete delivery details since it was not found in the registry
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}"}Update an existing delivery in the registry
| id | string |
| destination | string | unique id for the destination Deprecated | |
| account | string | unique id for the account | |
| customer | string | unique id for the customer | |
| platform | string | name of the platform | |
| use | string | use case Enum: | |
| product | string | unique id for the product | |
| schedule | date | scheduled delivery start date | |
| schedule | date | scheduled delivery end date | |
| execution | string | scheduled delivery execution frequency Enum: | |
| segments | list of segment details | ||
| object | object | audience details of the segment | |
| audience | string | unique id for the audience | |
| dp | array[integer] | data partner ids provided by DRM Service for a particular consumer and platform | |
| query | string | unique id for the query maxLength: 20 minLength: 20 | |
| parameters | object | Parameter values referred in the query statement |
xxxxxxxxxxcurl --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" } ]}'Successfully updated the delivery in the registry
| object | object | ||
| response | object | ||
| message | string | Success message indicating that the operation is successful | |
| delivery | object | ||
| platform | string | name of the platform | |
| use | string | use case Enum: | |
| schedule | date | scheduled delivery start date | |
| schedule | date | scheduled delivery end date | |
| execution | string | scheduled delivery execution frequency Enum: | |
| segments | list of segment details | ||
| object | object | audience details of the segment | |
| audience | string | unique id for the audience | |
| dp | array[integer] | data partner ids provided by DRM Service for a particular consumer and platform | |
| query | string | unique id for the query maxLength: 20 minLength: 20 | |
| parameters | object | Parameter values referred in the query statement | |
| delivery | string | unique id for the delivery | |
| expired | boolean | status flag indicating that the delivery schedule has been expired | |
| last | integer | timestamp when the delivery is last run | |
| next | 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 |
Failed to update the delivery since it was not found in the registry
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}"}De-activate a delivery in the registry
| id | string |
xxxxxxxxxxcurl --request DELETE \ --url '/api/v1.0//deliveries/%7Bid%7D' \ --header 'Authorization: Bearer {token}'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 |
Failed to de-activate the delivery since it was not found in the registry
xxxxxxxxxx{ "response": { "message": "{string}" }, "active": "{boolean}"}Get the paginated list of details of all the deliveries stored in the registry
| page | integer | Default: 1 |
xxxxxxxxxxcurl --get \ --url '/api/v1.0//deliveries' \ --header 'Authorization: Bearer {token}' \ --data page=1Successfully returned the paginated list of details of all the deliveries stored in the registry
| object | object | ||
| response | array[object] | ||
| platform | string | name of the platform | |
| use | string | use case Enum: | |
| schedule | date | scheduled delivery start date | |
| schedule | date | scheduled delivery end date | |
| execution | string | scheduled delivery execution frequency Enum: | |
| segments | list of segment details | ||
| object | object | audience details of the segment | |
| audience | string | unique id for the audience | |
| dp | array[integer] | data partner ids provided by DRM Service for a particular consumer and platform | |
| query | string | unique id for the query maxLength: 20 minLength: 20 | |
| parameters | object | Parameter values referred in the query statement | |
| delivery | string | unique id for the delivery | |
| expired | boolean | status flag indicating that the delivery schedule has been expired | |
| last | integer | timestamp when the delivery is last run | |
| next | 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 |
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": "{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}"}Add a new delivery to the registry
| object | object | ||
| platform | string | name of the platform | |
| use | string | use case Enum: | |
| schedule | date | scheduled delivery start date | |
| schedule | date | scheduled delivery end date | |
| execution | string | scheduled delivery execution frequency Enum: | |
| segments | list of segment details | ||
| object | object | audience details of the segment | |
| audience | string | unique id for the audience | |
| dp | array[integer] | data partner ids provided by DRM Service for a particular consumer and platform | |
| query | string | unique id for the query maxLength: 20 minLength: 20 | |
| parameters | object | Parameter values referred in the query statement |
xxxxxxxxxxcurl --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 } } ]}'Successfully added new delivery to the registry
| object | object | ||
| response | object | ||
| message | string | Success message indicating that the operation is successful | |
| delivery | object | ||
| platform | string | name of the platform | |
| use | string | use case Enum: | |
| schedule | date | scheduled delivery start date | |
| schedule | date | scheduled delivery end date | |
| execution | string | scheduled delivery execution frequency Enum: | |
| segments | list of segment details | ||
| object | object | audience details of the segment | |
| audience | string | unique id for the audience | |
| dp | array[integer] | data partner ids provided by DRM Service for a particular consumer and platform | |
| query | string | unique id for the query maxLength: 20 minLength: 20 | |
| parameters | object | Parameter values referred in the query statement | |
| delivery | string | unique id for the delivery | |
| expired | boolean | status flag indicating that the delivery schedule has been expired | |
| last | integer | timestamp when the delivery is last run | |
| next | 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 |
Failed to add new delivery to the registry
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}"}History
Get execution history of a delivery from the registry
| id | string |
| status | string | Enum: Default: all | |
| sort | string | Enum: Default: DESCENDING | |
| created | string |
xxxxxxxxxxcurl --get \ --url '/api/v1.0//history/%7Bid%7D' \ --header 'Authorization: Bearer {token}' \ --data status=all \ --data sort=DESCENDING \ --data created_date={created_date}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 | string | unique job id for the delivery execeution request | |
| status | string | job status | |
| promises | array[object] | list of promise details | |
| promise | string | unique job id for the promise of a delivery execeution request | |
| external | 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 |
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}"}Run
Execute query segment of the scheduled delivery from registry and deliver results as defined
| id | string |
xxxxxxxxxxcurl --request POST \ --url '/api/v1.0//run' \ --header 'Authorization: Bearer {token}' \ --data id={id}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 | string | unique job id for the delivery execution request | |
| active | boolean | feature flag indicating that the feature endpoint is interactive |
Failed to execute the delivery
xxxxxxxxxx{ "response": { "created": "{integer}", "job_id": "{string}" }, "active": "{boolean}"}