Data Warehouse API

Itron Analytics has a REST-based Data Warehouse API using the Open Data 4.0 protocol. For details on Open Data 4.0 (OData), see OData.org.

The basics parts of the API interaction are:

  1. Request an Authorization Token from the Itron Identity Service using a ClientID and Client Secret for your Tenant. For more information, see Requesting the authorization token from the Identity service.

    • The ClientID typically formatted as a 36-character GUID. For example: 355559a2-e7b9-4d3e-86b1-fbcb111111e9

    • The Client Secret is typically formatted as a 32-character alphanumeric string. For example: Yj3Pyi2MN4Hf1PhNx9yiaYg3xs32410na1

    • The Authorization Token is a JSON Web Token (JWT).

  2. Use the Authorization Token in your REST request to fetch a JSON response to an Open Data 4.0 protocol query. For more information, see Sending a request to the OData API.

  3. Process the sent JSON response data.

There are protections in place that will limit the result set to 10,000 records if there are not filters in the request.

For examples of requests and responses, see Example: retrieving account numbers and their revenue class and customer name where the account number is not null or Example: query interval reads for gas service points.

For information on the schema, see Schema or List of objects.