Usage

Get a workspace-scoped usage and credit report

get/v1/usage

Query parameters

fromstring date-time
tostring date-time

Exclusive report end

Response

Workspace usage report

request_idstring required
warningsstring[] required

Changes

Changed in 3 of the 4 revisions of this API.162224

  • c15615d549931618See the full diff
    • the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • removed the required property api_keys_active from the response with the 200 status

      response-required-property-removed

    • removed the required property billing_hold from the response with the 200 status

      response-required-property-removed

    • removed the required property credit_breakdown from the response with the 200 status

      response-required-property-removed

    • removed the required property credits_limit from the response with the 200 status

      response-required-property-removed

    • removed the required property credits_remaining from the response with the 200 status

      response-required-property-removed

    • removed the required property credits_used from the response with the 200 status

      response-required-property-removed

    • removed the required property daily_free_limit from the response with the 200 status

      response-required-property-removed

    • removed the required property daily_free_remaining from the response with the 200 status

      response-required-property-removed

    • removed the required property expiring_credits from the response with the 200 status

      response-required-property-removed

    • removed the required property period_end from the response with the 200 status

      response-required-property-removed

    • removed the required property period_start from the response with the 200 status

      response-required-property-removed

    • removed the required property plan_code from the response with the 200 status

      response-required-property-removed

    • removed the required property rate_limit_per_sec from the response with the 200 status

      response-required-property-removed

    • removed the required property tier from the response with the 200 status

      response-required-property-removed

    • removed the required property wallet_balance from the response with the 200 status

      response-required-property-removed

    • the optional response header x-request-id removed for the status 200

      optional-response-header-removed

    • api operation id getUsage removed and replaced with getUsageReport

      api-operation-id-removed

    • added the new optional query request parameter from

      new-optional-request-parameter

    • added the new optional query request parameter to

      new-optional-request-parameter

    • added ResponseMetadata subschema #2 to the response body allOf list for the response status 200

      response-body-all-of-added

    • removed the non-success response with the status 401

      response-non-success-status-removed

    • removed the non-success response with the status 403

      response-non-success-status-removed

    • removed the non-success response with the status 429

      response-non-success-status-removed

    • removed the non-success response with the status 500

      response-non-success-status-removed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6cccdc178a95412See the full diff
    • added the new internal_error enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • added the new internal_error enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • added the new internal_error enum value to the error/code response property for the response status 429

      response-property-enum-value-added

    • added the new internal_error enum value to the error/code response property for the response status 500

      response-property-enum-value-added

    • added the optional property error/request_id to the response with the 401 status

      response-optional-property-added

    • added the optional property error/request_id to the response with the 403 status

      response-optional-property-added

    • added the optional property error/request_id to the response with the 429 status

      response-optional-property-added

    • added the optional property error/request_id to the response with the 500 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 401 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 403 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 429 status

      response-optional-property-added

    • added the optional property error/subcode to the response with the 500 status

      response-optional-property-added

    • removed the api_error enum value from the error/code response property for the response status 401

      response-property-enum-value-removed

    • removed the api_error enum value from the error/code response property for the response status 403

      response-property-enum-value-removed

    • removed the api_error enum value from the error/code response property for the response status 429

      response-property-enum-value-removed

    • removed the api_error enum value from the error/code response property for the response status 500

      response-property-enum-value-removed

  • 503281cd9fb3174See the full diff
    • the optional response header x-request-id removed for the status 200

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 401

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 403

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 429

      optional-response-header-removed

    • the optional response header x-request-id removed for the status 500

      optional-response-header-removed

    • removed the optional property error/request_id from the response with the 401 status

      response-optional-property-removed

    • removed the optional property error/request_id from the response with the 403 status

      response-optional-property-removed

    • removed the optional property error/request_id from the response with the 429 status

      response-optional-property-removed

    • removed the optional property error/request_id from the response with the 500 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 401 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 403 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 429 status

      response-optional-property-removed

    • removed the optional property error/subcode from the response with the 500 status

      response-optional-property-removed

    • added the new api_error enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • added the new api_error enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • added the new api_error enum value to the error/code response property for the response status 429

      response-property-enum-value-added

    • added the new api_error enum value to the error/code response property for the response status 500

      response-property-enum-value-added

    • removed the internal_error enum value from the error/code response property for the response status 401

      response-property-enum-value-removed

    • removed the internal_error enum value from the error/code response property for the response status 403

      response-property-enum-value-removed

    • removed the internal_error enum value from the error/code response property for the response status 429

      response-property-enum-value-removed

    • removed the internal_error enum value from the error/code response property for the response status 500

      response-property-enum-value-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog