SIsitehive
Explanations

Get explanations

Returns a list of explanations for events where measurements exceeded predefined thresholds for each monitoring point.

get/sites/{site_id}/explanations

Request

  • Base URL
    https://api.sitehive.co (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

site_idstring required

Unique identifier of site that needs to be fetched.

Query parameters

start_datestring date-time required

The start date to filter results from. Must be in ISO 8601 UTC format (YYYY-MM-DDTHH:MM:SSZ). The range between start_date and end_date must be less than or equal to 1 day.

end_datestring date-time required

The end date to filter results. Must be in ISO 8601 UTC format (YYYY-MM-DDTHH:MM:SSZ). The range between start_date and end_date must be less than or equal to 1 day.

limitinteger

Maximum number of items returned in this response. (max 200)

offsetinteger

Number of items to skip. Increase by limit to fetch the next page.

Response

Default Response

Example response

{
  "data": [
    {
      "startDate": "2025-08-11T00:15:00Z",
      "endDate": "2025-08-11T02:15:00Z",
      "category": {
        "status": "Reportable",
        "classification": "Landscaping work"
      },
      "exceedances": [
        {
          "monitoringPointId": "a665a459cbbd",
          "ruleId": "a665a459cbbd"
        }
      ],
      "notes": "Exceedance from battery changeover."
    }
  ],
  "pagination": {
    "limit": 50,
    "hasNext": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.