List Export Job Executions

Export executions represent an export that has been or is being executed. Exports executions are available for 30 days.

Request
Security:
bearerAuth
path Parameters
parent
required
string

The ID of the export that created this execution.

query Parameters
pageToken
string

A page token, received from a previous call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token.

When paginating, other parameters provided to the call must match the call that provided the page token.

Note: If a nextPageToken is returned by the endpoint, there may be more results regardless of whether or not the exportJobExecutions array is empty. Users must call this API with the returned nextPageToken until an empty nextPageToken is returned if they want to ensure that they have received all results.

Example: pageToken=ayI9of.ea18tjsa_a14.eypIjkL10

pageSize
integer <int32>

The maximum size of the page results to return. Defaults to 50. Fewer results may be returned, but there may still be more on the next page.

Example: pageSize=10

orderBy
string

Comma separated list of fields to order by. Use "desc" after the field name for descending. Supported fields:

  • updateTime.

Example:

Oldest results first

orderBy=updateTime asc

filter
string

Comma separated values for a field to filter on.

General filter string syntax:

{field}{operator}{value(s)}

{field} can be "status"

{operator} can be one of [=, !=]. Ensure these are url encoded.

{value} must be the same data type as field.

Example:

Status = COMPLETE or FAILED

filter=status%3DCOMPLETE,FAILED

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.

get/exports/v1/exportJobs/{parent}/executions
Request samples
curl -i -X GET \
'https://api.terminusplatform.com/exports/v1/exportJobs/TACTIC_PERFORMANCE/executions?pageToken=&pageSize=50&orderBy=updateTime%20desc&filter=status%3DCOMPLETE,FAILED' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    3 more
    429
    500
    503
application/json
{}