We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience
Audience
Breadcrumbs

Data Extract Schedule REST API

This API allows management of Data Extract Schedules in cX::ad. Extract Schedules can be created, updated and deleted via this API.


When a schedule triggers it creates a Data Extract that can be managed via the Data Extract REST API.

Retrieving the list of Extract Schedules

GET

Retrieves a list of details of available Extract Schedules. Details returned include the type, period, locale, currency code and time zone of the schedule.

https://{cxadbaseurl}/api/secure/extractSchedules?extractType={extractType}&schedulePeriod={schedulePeriod}

Parameters:

  • cxadbaseurl - the base URL of the cX::ad system

  • extractType - optional filter for type - return schedules that match the type (ACCOUNT_LOW_BUDGET, ACCOUNT_TOTALS, ACCOUNT_TRANSACTIONS, INVENTORY_DISTRIBUTION or OPERATIONAL_FINANCE)

  • schedulePeriod - optional filter for period - return schedules that match the period (DAILY, WEEKLY, MONTHLY)

Example command:

curl -s -H "Content-type: text/xml" -u jsmith:password1 -X GET "https://cxad.cxense.com/api/secure/extractSchedules"

The following XML example shows the contents returned from a typical GET call:

 

 Click to view XML example

Individual Extract Schedules

GET

Retrieves details of a specific Extract Schedule. Details returned include the type, period, locale, currency code and time zone of the schedule.

https://{cxadbaseurl}/api/secure/extract/{extractId}

Parameters:

  • cxadbaseurl - the base URL of the cX::ad system

  • scheduleId - the unique id for the schedule to be retrieved.

Example command:

curl -s -H "Content-type: text/xml" -u jsmith:password1 -X GET "https://cxad.cxense.com/api/secure/extractSchedule/522c02620877473d806a4e96163732a0"

The following XML example shows the contents returned from a typical GET call:

 Click to view XML example

POST

Creates a new extract schedule based on the parameters provided.

https://{cxadbaseurl}/api/secure/extractSchedule

Parameters:

  • cxadbaseurl - the base URL of the cX::ad system

This XML example shows the contents required to be supplied for a POST call:

 Click to view XML example

Example command:

curl -s -H "Content-type: text/xml" -u jsmith:password1 -X POST "https://cxad.cxense.com/api/secure/extractSchedule" -d @input.xml

PUT

Updates an existing extract schedule with the parameters provided.

https://{cxadbaseurl}/api/secure/extractSchedule/scheduleId

Parameters:

  • cxadbaseurl - the base URL of the cX::ad system

  • scheduleId - the unique id for the schedule to be updated.

This XML example shows the contents required to be supplied for a POST call:

 Click to view XML example

Example command:

curl -s -H "Content-type: text/xml" -u jsmith:password1 -X PUT "https://cxad.cxense.com/api/secure/extractSchedule" -d @input.xml

DELETE

Remove an existing schedule.

https://{cxadbaseurl}/api/secure/extractSchedule/{scheduleId}

Parameters:

  • cxadbaseurl - the base URL of the cX::ad system

  • scheduleId - the unique id for the schedule to be deleted.

Example command:

curl -s -H "Content-type: text/xml" -u jsmith:password1 -X DELETE "https://cxad.cxense.com/api/secure/extractSchedule/7134723857104eb2974f71f752fbd44c"

Email Notifications

The following fields are used for email notifications:

  • userId - the user id of the user to email when the extract is complete.

  • baseUrl - the url to use for the download link in the email. This is appended with the path to the extract download page in cX::ad - manage/finance/extract/{extractId}

Both these fields are optional. If userId is not present then no email will be sent. If baseUrl is not present then an email without a download link will be sent.

Last updated: