Get Export Request

  • Updated on Apr 25, 2025
  • Published on Feb 25, 2025
Prev Next
Get
/logs/{request_handle}

Retrieves custom export request logs based on the provided request handle 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.

Path parameters
request_handle
stringRequired

The ID returned by the log export queue.

Query parameters
limit
integer (int32)

The maximum number of results to return.

Minimum1.0
format
string

Format of returned data. json or csv

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

Status of aggregate export

Result
{
  "status": "complete",
  "response_url": "https://branch-exports-web.s3.us-west-1.amazonaws.com/v2/y%3D2023/m%3D05/d%3D17/app_id%3D{APP_ID_HERE}/job_id%3D{JOB_ID_HERE}/task_id%3D{TASK_ID_HERE}/unique-csv-file-name-here.csv?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": 0,
  "code": 200
}
object
code
integer

Response code

Example200
lines_exported
integer

Number of lines exported against the originated request.

Example2000000
status
string

Request status over the current execution time

Valid values[ "pending", "running", "complete", "fail" ]
Examplecomplete
status_url
string

The URL of the export request.

Examplehttps://branch-exports-web.s3.us-west-1.amazonaws.com/v2/y%3D2023/m%3D05/d%3D17/app_id%3D{APP_ID_HERE}/job_id%3D{JOB_ID_HERE}/task_id%3D{TASK_ID_HERE}/unique-csv-file-name-here.csv?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}
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