INRIX IQ logo

The Signals Metrics Availability API provides information about the date availability range for intersection metrics from authenticated organizations or namespaces. This API returns the latest map version and available intersections for specified date ranges.

Overview

The Signals Metrics Availability API provides essential data availability information before making metrics requests. This support API enables efficient query planning and data discovery with:

Use Cases and Benefits

Query Planning: Verify data availability before submitting large metrics requests to avoid empty results and optimize API usage.

Data Discovery: Identify which intersections have data for specific time periods, enabling targeted analysis and reporting.

Map Version Management: Track map updates and ensure consistent spatial references across analysis workflows.

Operational Monitoring: Monitor data ingestion and identify coverage gaps for quality assurance processes.

Response Structure and Output Modes

Available Date Ranges: Each response includes discrete date ranges where data is available, with start and end dates being inclusive.

Map Version Information: Latest map version identifier in YYYYMMDD format, indicating the most recent spatial data update for each time period.

Output Mode Options:

Partner Integration: Namespace support enables partner organizations to check availability for their specific intersection provisioning and customizations.

Endpoints

Endpoint Summary

Method Path Description
GET /v1/metrics/intersections/availability Retrieve available date ranges, map versions, and (optionally) intersection inventories for the authenticated organization or namespace

Required Headers

Query Parameters

Parameter Type Required Default Notes
startDate string   (none) Inclusive lower bound in YYYY-MM-DD format.
endDate string   (none) Inclusive upper bound in YYYY-MM-DD format.
intersectionOutputMode string   none none returns only date windows; all merges intersection IDs across the full request range.
namespaces string   (none) Comma-separated partner namespaces when querying partner app tokens (internal use).

Response Fields

Field Description
createdDate Timestamp when availability snapshot was generated.
responseId Trace identifier for support tickets.
data[].availableDateRange Inclusive start/end boundaries with data coverage.
data[].latestMapVersion Map version (YYYYMMDD) aligned with the reporting window.
data[].intersectionIds Present when intersectionOutputMode=all; flattened list of intersection IDs with data in the window.

Examples

Minimal Range Lookup

GET /v1/metrics/intersections/availability?startDate=2024-03-01&endDate=2024-03-31&intersectionOutputMode=none
Authorization: Bearer <token>

Response excerpt (JSON):

{
  "createdDate": "2025-02-18T02:45:03Z",
  "responseId": "0d7d64f1-c79a-4dc3-a9b6-6fb0b4b21f3b",
  "data": [
    {
      "availableDateRange": {
        "startDate": "2024-03-01",
        "endDate": "2024-03-31"
      },
      "latestMapVersion": "20240301"
    }
  ]
}

Intersection Inventory for Partners

GET /v1/metrics/intersections/availability?startDate=2024-06-01&endDate=2024-06-07&intersectionOutputMode=all&namespaces=sig-ssi::production::27294069-63b2-4a25-b343-79544c74cb30
Authorization: Bearer <partner-token>

Response excerpt (JSON):

{
  "createdDate": "2025-02-18T03:02:17Z",
  "responseId": "e97af4f5-2438-4d09-8f65-00b2ecf9158d",
  "data": [
    {
      "availableDateRange": {
        "startDate": "2024-06-01",
        "endDate": "2024-06-07"
      },
      "latestMapVersion": "20240615",
      "intersectionIds": [
        "45.4978_-122.6376",
        "45.4977_-122.6376",
        "38.9127_-76.8387"
      ]
    }
  ]
}