Panels contain information about the circuit panel within a building.

Example Panel

{
  // primary key of panel
  "id": 169,

  // name of panel
  "name": "Panel 1",

  // voltage of panel
  "voltage": 120,

  // phases of panel
  "phases": "3",

  // building associated with the panel
  "building_id": 166,

  // circuits associated with the panel
  "circuit_ids": [
    1765,
    1766,
    1767
  ]
}

GET /api/v1/panels
List panels

Returns details about all accessible panels.

Example Request

$ curl -i https://app.verdigris.co/api/v1/panels -H "Authorization: Token token=<access_token>"

Examples

{
  "panels": [
    {
      "id": 169,
      "name": "Panel 1",
      "voltage": 120,
      "phases": "3",
      "building_id": 166,
      "circuit_ids": [
        1765,
        1766,
        1767
      ]
    },
    {
      "id": 170,
      "name": "Panel 2",
      "voltage": 120,
      "phases": "3",
      "building_id": 166,
      "circuit_ids": [
        1807,
        1808,
        1809
      ]
    }
  ]
}

GET /api/v1/panels/:id
Show a panel

Returns details about requested panel.

Example Request

$ curl -i https://app.verdigris.co/api/v1/panels/169 -H "Authorization: Token token=<access_token>"

Examples

{
  "id": 169,
  "name": "Panel 1",
  "voltage": 120,
  "phases": "3",
  "building_id": 166,
  "circuit_ids": [
    1765,
    1766,
    1767
  ]
}

Params

Param name Description
id
required

panel id


Value:

Must be String


GET /api/v1/panels/:panel_id/power
Power data for a panel

Returns the power data in Watts for the requested panel.

Example Request

$ curl -i https://app.verdigris.co/api/v1/panels/169/power -H "Authorization: Token token=<access_token>"

Examples

// keys are unix epoch timestamps in string format, values are Watt-hours
{
  "1411430400": 993.6999999999998,
  "1411516800": 914.8000000000001,
  "1411603200": 985.3000000000002
}

Params

Param name Description
panel_id
required

panel id


Value:

Must be String

end_time
optional

End time in unix timestamp


Value:

Must be String

interval
optional

Time granularity in minutes (default: 1440)


Value:

Must be String

limit
optional

Number of results (default: 30, max: 300)


Value:

Must be String

start_time
optional

Start time in unix timestamp (default: 0)


Value:

Must be String


GET /api/v1/panels/:panel_id/energy
Energy data for a panel

Returns the energy data in Watt-hours for the requested panel.

Example Request

$ curl -i https://app.verdigris.co/api/v1/panels/169/energy -H "Authorization: Token token=<access_token>"

Examples

// keys are unix epoch timestamps in string format, values are Watt-hours
{
  "1411430400": 906.5999999999999,
  "1411516800": 993.7999999999998,
  "1411603200": 980.1999999999998
}

Params

Param name Description
panel_id
required

panel id


Value:

Must be String

end_time
optional

End time in unix timestamp


Value:

Must be String

interval
optional

Time granularity in minutes (default: 1440)


Value:

Must be String

limit
optional

Number of results (default: 30, max: 300)


Value:

Must be String

start_time
optional

Start time in unix timestamp (default: 0)


Value:

Must be String