usage

Get your usage

Returns your account's charged tool calls and successful builds in a time range, optionally per integration, per member or as a series.

  • A charged call is a tool call that finished with a result, or that refused your input itself, counted when Pomerado accepted it. A call that failed because the tool or the website broke is free, and so is one a repair finished. A build counts when it published a tool.
  • With interval, the range also comes as a series of UTC hours, days or months.
  • With group_by member, an Owner or Admin sees every member, including those who have left; a Member sees only their own row.
  • coverage.complete says whether the whole range lies within recorded history.
get/v1/usage

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/usage
  • Auth: HTTP bearer

Query parameters

fromstring

Start of the range, inclusive (default: when recording began)

tostring

End of the range, exclusive (default: now)

group_by'integration' | 'member'

integration: also list each integration's calls and integrations created. member: also list each member's calls and integrations created

interval'hour' | 'day' | 'month'

Also return the range as a series of UTC hours, days or months, at most 1000 buckets. Without from, the series starts at the bucket holding coverage.started_at

Response

Your usage in the range

fromstring nullable required
tostring required
as_ofstring required
callsinteger required

Charged tool calls in the range

last_used_atstring nullable required
unattributed_callsinteger required

Calls in the range recorded before calls named their integration

integrations_createdinteger required

Successful builds in the range: each build that published a tool, including one that added a tool to an existing integration

Example response

{
  "groups": [
    {
      "integration_id": "int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
    }
  ]
}

Changes

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