Skip to content
Figur

Paginated per-route usage rollup

GET
/v1/usage
 
curl --request GET \
  --url 'https://example.com/v1/usage?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
Limit
integer
default: 50 >= 1 <= 200
offset
Offset
integer
0

Header Parameters

Section titled “Header Parameters ”
X-Shopify-Hmac-Sha256
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
UsageResponse

GET /v1/usage — paginated request_logs for the calling client.

object
items
required
Items
Array<object>
UsageRow

One row of the calling client’s request history.

object
request_id
required
Request Id
string
endpoint
required
Endpoint
string
method
required
Method
string
status
required
Status

PENDING | SUCCESS | FAILED | REFUNDED.

string
http_status
Any of:
integer
credits_charged
required
Credits Charged
integer
credits_refunded
required
Credits Refunded
integer
job_id
Any of:
string
created_at
Any of:
string
submitted_at
Any of:
string
resolved_at
Any of:
string
latency_ms
Any of:
integer
error_code
Any of:
string
error_message
Any of:
string
total
required
Total
integer
limit
required
Limit
integer
offset
required
Offset
integer
Example generated
{
  "items": [
    {
      "request_id": "example",
      "endpoint": "example",
      "method": "example",
      "status": "example",
      "http_status": 1,
      "credits_charged": 1,
      "credits_refunded": 1,
      "job_id": "example",
      "created_at": "example",
      "submitted_at": "example",
      "resolved_at": "example",
      "latency_ms": 1,
      "error_code": "example",
      "error_message": "example"
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}