Retrieve organization usage reports

post/organization/usage

Request

Request body

periodIdstring

period ID, typically the year followed by either the ISO 8601 week number or month number

organizationIdstring

organization ID

nextTokenstring

Token used for pagination. Omitted if there are no more results.

Example request

{
  "periodId": "12341234-1234-1234-1234-123412341234",
  "organizationId": "12341234-1234-1234-1234-123412341234",
  "nextToken": "12341234-1234-1234-1234-123412341234"
}

Response

Success

nextTokenstring

Token used for pagination. Omitted if there are no more results.

Example response

{
  "usageReports": [
    {
      "organizationId": "12341234-1234-1234-1234-123412341234",
      "periodId": "12341234-1234-1234-1234-123412341234",
      "activeCount": 10,
      "createdCount": 10,
      "analyzedCount": 10,
      "deliveredCount": 10,
      "activeAreaKm2": 10,
      "createdAreaKm2": 10,
      "analyzedAreaKm2": 10,
      "deliveredAreaKm2": 10,
      "active30mAreaKm2": 10,
      "created30mAreaKm2": 10,
      "analyzed30mAreaKm2": 10,
      "delivered30mAreaKm2": 10,
      "active10mAreaKm2": 10,
      "created10mAreaKm2": 10,
      "analyzed10mAreaKm2": 10,
      "delivered10mAreaKm2": 10
    }
  ]
}

Changes

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