Batchrun URL

{ApiServerUrl}/${namespace}/${entity}/BATCH_RUN_ID/batchrun?limit=1000

The /batchrun service returns data in an envelope, with the form:

{
  "batchrun":[...],
  "requestId":"A011.1598447117.14",
  "timeToFirstWrite":2
  "after": "19101427"
}
  • batchrun contains the data of the batchrun as a JSON array.
  • requestId should be added to your logs to enable correlation of client logs with server logs in case of troubleshooting.
  • timeToFirstWrite gives the processing time that elapsed on the REST API server before the server started sending the response to the client.
  • after is the value to use for the after parameter in the next request to obtain the next page of data in the batch run.

Note: If no limit is applied, or there is no additional data to download, the response will not have an after field.

/batchruns URL

The batch run IDs that have data for a given entity can be discovered using this URL (note the "s" in /batchruns):

{ApiServerUrl}/${namespace}/${entity}/batchruns?limit=10&descending=true

This above example returns the ten most recent batch runs for ${entity}.

/batchrun compared to /timeseries

Both the /batchrun and the /timeseries services give access to historical data. There are important differences.

  1. The /timeseries data may be available at a slight later time than /batchrun.

  2. Data can be downloaded faster from the /batchrun service.

  3. In cases where a batch run is republished for the same asOf, data from the more recent batch run will overwrite any matching records from the first run in the time series. As a result, the /timeseries service can only give the full results for the most recent batch run for any given asOf. In contrast, the /batchrun service gives full results for any given batch run ID.

    Important: The data in the /batchrun service is immutable, and is not updated for any subsequent corrections or enhancements. In contrast, the data in the /timeseries service shows the most correct or enhanced record available for any point in the time series.

Back to help overview