SIsitehive
Rules

Get rule information

Returns information about a specific rule identified by its rule_id

get/sites/{site_id}/rules/{rule_id}

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.

rule_idstring required

Unique identifier of rule that needs to be fetched.

Response

Represents a rule that can be applied to a monitoring point to check for exceedances or events.

idstring required

Unique identifier for the rule.

namestring required

The name or title of the rule.

aspectstring required

The aspect of the rule, e.g., 'Noise'.

startDatestring date-time required

ISO 8601 UTC timestamp indicating when the rule became active.

endDatestring date-time required

ISO 8601 UTC timestamp indicating when the rule ended or was deactivated. Null if still active.

Example response

{
  "id": "a665a459cbbd",
  "name": "Residential Structural Limit",
  "aspect": "Noise",
  "startDate": "2025-08-11T00:15:00Z",
  "endDate": "2025-08-30T23:59:59Z"
}

Changes

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