A Reading captures a snapshot of an Entity’s state. We periodically create Readings for each Entity to track how their state changes over time.

Entities of the same type produce similarly structured Readings, allowing you to process them uniformly regardless of their manufacturer.

​
What makes Readings useful

Our Readings API is built for performance and designed to handle large volumes of data.

Because Readings are consistent and normalized across all Entities, they provide a solid foundation for building real-time experiences, reporting tools, and cloud-based services that interact with your devices.

And in most cases, Readings are stored indefinitely. This gives you long-term access to historical data, ideal for building timelines, tracking changes, and powering applications that rely on deeper analysis.

​
What you’ll need

  • Your API credentials
  • An Entity of any type ​

​
Let’s try it out

Use the to List all Readings for it.

You’ll also have to specify a date. Readings that came in before this time won’t be part of the response.

​
start
string
required

The Reading Object for your Entity might look different from the one in the example below.

Response (Body)
{
    "data": [
        {
            "id": "71795703-1d72-[...]",
            "entityId": "bd297b95-5579-[...]",
            "measured": "2024-09-03T02:06:39Z",
            "received": "2024-09-03T02:06:44.6020711Z",
            "processed": "2024-09-03T02:06:44.9891195Z",
            "data": {
                "instantaneousCurrent": {
                    "l1": 2.95,
                    "total": 2.95,
                    "unit": "A"
                },
                "instantaneousVoltage": {
                    "l1": 242.3,
                    "total": 242.3,
                    "unit": "V"
                },
                "negativeActiveEnergy": {
                    "t1": 12794452,
                    "t2": 5067134,
                    "total": 17861586,
                    "unit": "Wh"
                },
                "negativeActiveInstantaneousPower": {
                    "total": 715,
                    "unit": "W"
                },
                "positiveActiveEnergy": {
                    "t1": 6538224,
                    "t2": 8590571,
                    "total": 15128795,
                    "unit": "Wh"
                },
                "positiveActiveInstantaneousPower": {
                    "total": 0,
                    "unit": "W"
                }
            }
        }, ...
    ]
}

Caution
The object might not be available to you. However, our Location Matching feature is a privacy-friendly alternative available to all users.