Export Download Status

  • Published on Feb 25, 2025
Prev Next
Get
/analytics/{job_id}

By passing in the appropriate options, you can receive a URL to your aggregate export.

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.

Path parameters
job_id
stringRequired

The unique ID of the request. Obtained from the Export Request.

Query parameters
limit
integer (int32)

The maximum number of results to return.

Minimum1
Maximum50000
format
string

Format of returned data. json or csv

Valid values[ "csv", "json" ]
Default"csv"
Responses
200

Status of aggregate export

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/v2/analytics/{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