Get Export Download Status

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

This endpoint provisions querying and export Cohort analytics

Security
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

Unique identifier for job. Obtained from POST Export Cohort Analytics API.

Example0000-XXxx
Query parameters
app_id
stringRequired

app_id | Unique identifier for Branch app of requested data. Either appId or organization_id is required.

format
string

Format of returned data. json or csv

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

Status of aggregate export

object
status
string

Status of the query.

Valid values[ "FINISHED", "QUEUED", "RUNNING", "ERROR" ]
ExampleFINISHED
code
string

HTTP code representing the outcome of the status request. Output can be for 1xx/2xx/4xx/5xx. A 1xx will denote a QUEUED or RUNNING status.

Example200
response_url
string

S3 url for downloading the response data.

Examplehttps://api2.branch.io/v2/analytics/{UNIQUE_ALPHANUMERICAL_STATUS_PATH_HERE}
error_message
string

Error message if the query failed

ExampleN/A
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