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
appId & accessToken
API Key: appId
Query parameter nameapp_id
app_id | Unique identifier for Branch app of requested data.
API Key: accessToken
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
Query parameters
app_id
stringRequired
The unique identifier for the app. Alternatively, provide organization_id
.
Responses
200
400
404
Job Successfully Finished
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}