Retrieve Download Status

  • Published on Feb 25, 2025
Get
/branch_aggregate/async/status/{job_id}

Receive a status update on your aggregate export request, as well as a URL to the data.

Security
API Key
Query parameter nameapp_id

app_id | Unique identifier for Branch app of requested data.

API Key
Header parameter nameAccess-Token

Key that encapsulates the user's permission with regards to an organization. Obtained from the Branch Dashboard and needed for authentication.

Path parameters
job_id
stringRequired

The unique ID of the request. Obtained from the export request.

Query parameters
app_id
stringRequired

The unique identifier for the app. Alternatively, provide organization_id.

Responses
200

Job Successfully Finished

Result
"{\n  \"code\": 200\n  \"status\": \"FINISHED\"\n  \"response_url\": \"https://branch-exports.s3.amazonaws.com/partner-query/2023-05-12-2023-05-19-eo_install-day-unique-id-here.csv?Signature={SIGNATURE_HERE}%3D&AWSAccessKeyId={AWS_ACCESS_KEY_ID_HERE}&Expires={EXPIRATION_HERE}\"\n}"
object
code
integer

Response code

Example200
job_id
string

The unique ID of the request.

ExampleXXXX-0000-xxxx
status_url
string

The URL of the export request.

Examplehttps://api2.branch.io/v1/branch_aggregate/async/status/{JOB_ID_HERE}
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