PHphala
Apps

Get app metered usage

Changed on

Returns billing usage records from ClickHouse. Defaults to 7-day window if dates not specified.

get/api/v1/apps/{app_id}/usage

Request

Path parameters

app_idstring required

Hex app identifier

Query parameters

start_datestring date-time nullable

Start date (ISO 8601)

Example:2024-01-01T00:00:00Z
end_datestring date-time nullable

End date (ISO 8601)

Example:2024-01-01T00:00:00Z
limitinteger

Max records to return

offsetinteger

Records to skip

Response

Usage records with cost breakdown

totalinteger required

Number of records returned

total_costnumber required

Sum of costs in USD

Example response

{
  "usage": [
    {
      "project_id": "prj_0123abcd",
      "team_id": "wks_0123abcd"
    }
  ]
}

Changes

  • c71a8dc90391Revision changes
    • breaking

      response property usage/items/project_id list-of-types was widened by adding types string to media type application/json of response 200

    • breaking

      response property usage/items/team_id list-of-types was widened by adding types string to media type application/json of response 200