Download completed export

Download a previously requested export file.

You can create and view your API Private Key here.

This endpoint is useful for larger files that may time out when using the Export content endpoint.

Instructions for using this endpoint:

  1. Call the Export content endpoint with the deferred parameter set to true.
  2. Grab the returned exportId to use with this endpoint.
  3. Make the call to this endpoint providing the projectKey and exportId on the query string.
  4. If the status is set to completed in the response then a signed link will be provided.
    1. Navigate to the signed link to retrieve the file.
      1. The link will expire in 30 minutes after the file is created.
  5. If the status shows in-progress in the response then continue to call the endpoint until it is set to completed.
  6. If the status shows failed in the response then an error occurred and will be noted.

Try it

To test this endpoint using the Try It feature:

  1. Copy your Localize API Key into the Header field in the AUTHENTICATION section on the right.
  2. Fill in all required fields below, and any optional fields as needed.
  3. Click the Try it button.
  4. View the results and any error returns on the right side of the screen.

Feel free to copy the sample code provided on the right side of the screen into your source code project to get a start on using this endpoint.

Note that using the Try It feature will affect the data in your Localize dashboard!

Click Try It! to start a request and see the response here!