GET - Get request info

The EXPORT API allows you to create EXPORT requests and get their status. This page documents the request endpoint.

Request structure

Route

The EXPORT API exposes a GET endpoint to get the status of a single EXPORT request:

https://api.batch.com/1.0/BATCH_API_KEY/export/request/REQUEST_ID

Here is a valid cURL example:

curl -H "Content-Type: application/json" \
     -H "X-Authorization: BATCH_REST_API_KEY" \
     -X GET "https://api.batch.com/1.0/BATCH_API_KEY/export/request/REQUEST_ID"

The REQUEST_ID value is the token you get when creating the request.

The BATCH_API_KEY value is either your Live or Dev Batch API key from the settings page of your app within the dashboard (⚙ Settings → General).

Headers

In order to authenticate with the API, you need to provide your company REST API Key as the value of the X-Authorization header.

Responses

Success

Response example

{
  "id": "9aed764e-7a79-4197-b378-df82da994f78",
  "uri": "/1.0/BATCH_API_KEY/inapp-campaign/CAMPAIGN_TOKEN/events",
  "request_date": "2019-08-14T22:00:00",
  "file_url": "http://my.url",
  "status": "CREATED|PENDING|ERROR|SUCCESS",
  "completion_date": "2019-08-14T22:00:00",
  "request" :  
  {
    "from": "2019-08-14T22:00:00",
    "to": "now",
    "events": ["push_sent", "push_open"],
    "ids": ["install_id", "custom_id", "advertising_id"],
  }
}

The file value allows you two download a csv file containing the requested data. The link to the csv file wil expire after 20 minutes. You will need to call again the API to generate a new file.

The error_msg field gives you some information about what went wrong.

Failure

If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at support@batch.com if you need further support.

• AUTHENTICATION_INVALID (HTTP status code: 401, Error code: 10)
• ROUTE_NOT_FOUND (HTTP status code: 404, Error code: 20)
• MISSING_PARAMETER (HTTP status code: 400, Error code: 30)
• MALFORMED_PARAMETER (HTTP status code: 400, Error code: 31)
• SERVER_ERROR (HTTP status code: 500, Error code: 1)
• MAINTENANCE_ERROR (HTTP status code: 503, Error code: 2)