---
updatedAt: 2026-05-28T08:16:45.000Z
agentTools:
  projectIndex: https://docs.scalr.io/llms.txt
---

# List Scalr Usage Statistics

This endpoint returns billing usage statistics for an account within a period of time.

Required permission: accounts:billing


# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "UsageStatistic": {
        "properties": {
          "attributes": {
            "properties": {
              "breakdown-id": {
                "description": "The identifier of a resource by which the usage is broken down",
                "nullable": true,
                "type": "string"
              },
              "breakdown-name": {
                "description": "The name of a resource by which the usage is broken down",
                "nullable": true,
                "type": "string"
              },
              "date": {
                "description": "The date when usage has been recorded",
                "format": "date",
                "nullable": true,
                "type": "string"
              },
              "runs-count": {
                "default": 0,
                "description": "The count of runs finished within the date",
                "type": "integer"
              },
              "runs-seconds": {
                "default": 0,
                "description": "The duration of runs in seconds within the date",
                "type": "integer"
              }
            },
            "type": "object"
          },
          "id": {
            "readOnly": true,
            "type": "string"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "relationships": {
            "properties": {
              "account": {
                "description": "The account id usage is reported for",
                "properties": {
                  "data": {
                    "nullable": true,
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "accounts",
                          ""
                        ],
                        "type": "string"
                      }
                    },
                    "required": [
                      "type",
                      "id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data"
                ],
                "type": "object"
              }
            },
            "type": "object"
          },
          "type": {
            "enum": [
              "usage-statistics"
            ],
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "type": "object"
      },
      "UsageStatisticListingDocument": {
        "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure",
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/UsageStatistic"
            },
            "type": "array"
          },
          "included": {
            "items": {
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "readOnly": true,
            "type": "object"
          },
          "meta": {
            "readOnly": true,
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "API-Key": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Scalr IACP API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "title": "Scalr IACP API",
    "version": "unversioned"
  },
  "openapi": "3.0.0",
  "paths": {
    "/usage-statistics": {
      "get": {
        "description": "This endpoint returns billing usage statistics for an account within a period of time.\n\nRequired permission: accounts:billing\n",
        "operationId": "list_usage_statistics",
        "parameters": [
          {
            "description": "The date filter. Example: `filter[date]=between:2022-01-01T00:00:00Z,2022-02-01T00:00:00Z`",
            "in": "query",
            "name": "filter[date]",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter data by account. This filter is applicable only for the parent control tower account. Example: `filter[account]=acc-ttpu7uslju6igv8`",
            "in": "query",
            "name": "filter[account]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Breakdown by environment or workspace.",
            "in": "query",
            "name": "breakdown_by",
            "required": false,
            "schema": {
              "enum": [
                "account",
                "environment",
                "workspace"
              ],
              "type": "string"
            }
          },
          {
            "description": "Summarize usage statistics by the whole period.",
            "in": "query",
            "name": "total",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "examples": {
                  "default": {
                    "value": "{\n    \"data\": [\n        {\n            \"attributes\": {\n                \"breakdown-id\": null,\n                \"breakdown-name\": null,\n                \"date\": \"2022-01-06\",\n                \"runs-count\": 4,\n                \"runs-seconds\": 82\n            },\n            \"id\": \"0209139b4a4f7068241f79e13e362a2bac0638aefc1fb2ea3caa136d0d47dca1\",\n            \"links\": null,\n            \"relationships\": {\n                \"account\": {\n                    \"data\": {\n                        \"id\": \"acc-ttpu7uslju6igv8\",\n                        \"type\": \"accounts\"\n                    }\n                }\n            },\n            \"type\": \"usage-statistics\"\n        }\n    ],\n    \"included\": null,\n    \"links\": {\n        \"first\": \"https://my.scalr.io/api/iacp/v3/usage-statistics?filter%5Bdate%5D=between%3A2022-01-01T00%3A00%3A00Z%2C2022-02-01T00%3A00%3A00Z&filter%5Baccount%5D=acc-abcdef&page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n        \"last\": \"https://my.scalr.io/api/iacp/v3/usage-statistics?filter%5Bdate%5D=between%3A2022-01-01T00%3A00%3A00Z%2C2022-02-01T00%3A00%3A00Z&filter%5Baccount%5D=acc-abcdef&page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n        \"next\": null,\n        \"prev\": null,\n        \"self\": \"https://my.scalr.io/api/iacp/v3/usage-statistics?filter%5Bdate%5D=between%3A2022-01-01T00%3A00%3A00Z%2C2022-02-01T00%3A00%3A00Z&filter%5Baccount%5D=acc-abcdef&page%5Bnumber%5D=1&page%5Bsize%5D=20\"\n    },\n    \"meta\": {\n        \"pagination\": {\n            \"current-page\": 1,\n            \"next-page\": null,\n            \"prev-page\": null,\n            \"total-count\": 0,\n            \"total-pages\": 1\n        }\n    }\n}"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/UsageStatisticListingDocument"
                }
              }
            },
            "description": "Success."
          },
          "403": {
            "description": "User unauthorized to perform the action."
          },
          "404": {
            "description": "Account or environment not found."
          },
          "4XX": {
            "description": "Client error."
          },
          "5XX": {
            "description": "Server error."
          }
        },
        "summary": "List Scalr Usage Statistics",
        "tags": [
          "usage-statistics"
        ],
        "x-resource": "UsageStatistic",
        "x-service": "tf-api"
      }
    }
  },
  "security": [
    {
      "API-Key": []
    }
  ],
  "servers": [
    {
      "url": "https://{Domain}/api/iacp/v3",
      "variables": {
        "Domain": {
          "default": "example.scalr.io",
          "description": "Domain where Scalr is hosted"
        }
      }
    }
  ]
}
```