Creates an Export Job

Creates/Overwrites an export job of the given type

Request
Security:
bearerAuth
Request Body schema: application/json

The export to create.

Note: If the export type specified has already been created, it will be overwritten.

type
required
string (Report Type)

The type of export to execute. All available report types may be found here

schedule
string (Execution Schedule)

Schedule at which to run the report. Detailed explanation and example schedules

Please review the documentation for the report type here for a recommended maximum schedule

Responses
200

A successful response.

400

Returned when bad request is received.

401

Returned when a request is made without a valid API key

403

Returned when the given user does not have permissions on the requested resource

404

Returned when the given resource is not found

429

Returned when the given user has reached their API rate limits.

500

Returned when there is an unrecoverable error in the API. If you continue to receive this error, please contact support and include your terminus-request-id.

503

Returned when the service is currently unavailable.

post/exports/v1/exportJobs
Request samples
    1 more
    Java
application/json
{
  • "type": "TACTIC_PERFORMANCE",
  • "schedule": "0 0 1 * *"
}
Response samples
    3 more
    429
    500
    503
application/json
{
  • "id": "TACTIC_PERFORMANCE",
  • "type": "TACTIC_PERFORMANCE",
  • "schedule": "0 0 1 * *"
}