Details on Single Export Job

  • Published on Feb 25, 2025
Get
/scheduled-exports/logs/subscription/{subscription_id}/job/{job_id}

This endpoint provides a way to get details on the particular job, as long as you know the subscription_id and the job_id. Scheduled exports run at a regular cadence. Each individual run is considered a "job" and has a "job Id".

Security
API Key
Query parameter nameapp_id

app_id | Unique identifier for Branch app of requested data.

API Key
Header parameter nameaccess-token

Access-Token | Key that encapsulates the users permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

API Key
Query parameter nameorganization_id

organization_id | the organization Id with which the Access Token and subscriptions are associated

Path parameters
subscription_id
stringRequired

A persistent id for the specific subscription.

ExampleXXXX-0000-xxxx
job_id
stringRequired

The relevant job Id.

ExampleXXXX-0000-xxxx
Responses
200

Export Job success response

object

Export Job Body

job_id
string

A persistent identifier for this export job run

ExampleXXXX-0000-xxxx
status
string

whether the job is in progress, succeeded or failed. Available options are PENDING_GENERATION, PENDING_UPLOAD, RUNNING, SUCCEEDED and FAILED

Valid values[ "PENDING_GENERATION", "PENDING_UPLOAD", "RUNNING", "SUCCEEDED" ]
ExampleSUCCEEDED
start_date
string

The earliest date for which exported objects will be included. Format is set to yyyy-MM-dd'T'HH:mm:ssZ. Timezone is UTC.

Example2023-05-19T00:00:00.000-00:00
end_date
string

The latest date for which exported objects will be included. Format is set to yyyy-MM-dd'T'HH:mm:ssZ. Timezone is UTC. Please note that this includes data through the final millisecond. So if end_date is 2023-05-30T19:59:59, this export job run will include data through the final millisecond i.e. 2023-05-30T19:59:59.999.

Example2023-05-20T00:00:00.000-00:00
export_url
Array of string

if the export job is for a subscription with destination.subscription_type set to branch, then this will be an array of pre-signed S3 URLs for export files that you can then download.

string
Examplehttps://branch-exports-web.s3.us-west-1.amazonaws.com/v2/y%3D2021/m%3D09/d%3D16/app_id%3D{APP_ID_HERE}/job_id%3D{JOB_ID_HERE}/task_id%3D{TASK_ID_HERE}/unique-csv-file-name-here.csv.gz?X-Amz-Algorithm={AMZ_ALGORITHM_HERE}&X-Amz-Date={AMZ_DATE_HERE}&X-Amz-SignedHeaders={AMZ_SIGNED_HEADERS_HERE}&X-Amz-Expires={AMZ_EXPIRATION_HERE}&X-Amz-Credential={AMZ_CREDENTIAL_HERE}&X-Amz-Signature={AMZ_SIGNATURE_HERE}
lines_exported
integer

Number of objects in the export (e.g. CSV rows).

Example43
400

Authentication Failed

Result
"{\n    \"error\": {\n        \"message\": \"Authentication failed !\",\n        \"code\": 400\n    }\n}"
Expand All
object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400
404

Job ID Not Found