How to retrieve time series results

Some Altitude analytical endpoints support time series breakdowns. Enable them with generateTimeSeries: true in your request parameters, then retrieve the results using .time_series_results().

Note: The code examples in this article use the altitude-sdk Python package. For direct REST calls, see Making an API Request with a POST Request. For the full job submission and polling pattern, see Making analytical API requests.

The following modules support time series results: Origin/Destination (closed, corridor, open matrix), POI Analytics, Regional Travel Metrics (demand generation, idle metrics, modeled VDT, observed counts, VDT), and Stop Analytics (fuel point analytics).

When generateTimeSeries is set to true, the job produces two sets of results: the main analysis results and a time series breakdown. Retrieve them separately after the job completes.

Using the Python SDK

from altitude_sdk import AltitudeClient

client = AltitudeClient(api_key="your-api-key")

params = {
  "dateRanges": [
    {
      "dateFrom": "2026-01-01",
      "dateTo": "2026-01-31"
    }
  ],
  "externalZoneType": "County",
  "generateTimeSeries": false,
  "isMetric": false,
  "zoneFlowTypes": [
    "I:I"
  ],
  "zones": [
    {
      "code": "32003",
      "iso_3166_2": "US-NV",
      "type": "County"
    }
  ]
}

wf = client.origin_destination.open_matrix(params)

# Retrieve main analysis results
rows = wf.all()

# Retrieve time series results (available after .all() completes)
time_series_rows = wf.time_series_results()

Using the REST API directly

If calling the REST API directly, set generateTimeSeries to true in your request body. After the main job completes, the response body includes a links.result URL for the main results. Poll the time series endpoint separately:

  1. Submit the job with generateTimeSeries: true.
  2. Poll GET /api/v2/jobs/{id} until status is DONE.
  3. Retrieve main results from GET /api/v2/{module}/{id}.
  4. Retrieve time series results from GET /api/v2/{module}/{id}/time-series.

For full endpoint documentation, see the Altitude API Guide.

Previous
Next