webdbs

WebDBs credit usage

Changed on

Returns WebDB credit, row, sync, and storage usage.

get/webdbs/usage

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/webdbs/usage
  • Auth
    HTTP bearer

Query parameters

fromstring date-time

Start of the usage period.

tostring date-time

End of the usage period.

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Usage summary

rows_totalinteger required

Current rows across all collections.

storage_gbnumber required

Snapshot storage used in gigabytes.

Example response

{
  "breakdown_by_collection": [
    {
      "collection_id": "col_123"
    }
  ]
}

Changes

    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

    • warning

      added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the response property for the response status