usage

List requests

Lists requests to /v1 endpoints, newest first, with each one's status, credits and credential.

GET /v1/me is not included, nor are requests refused for a missing or invalid credential.

get/usage/request

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/usage/request
  • Auth: HTTP bearer

Query parameters

request_idstring nullable

Only the request with this id, from the request-id response header.

routestring[]

Only requests to these endpoints, as path templates such as /v1/parcel. Repeat for several.

keystring nullable

Only requests made with this API key id.

userstring nullable

Only requests made by this user id, directly or through an OAuth client.

clientstring nullable

Only requests made through this OAuth client id.

actor_methodstring[]

Only requests authenticated this way. One of session, api_key, oauth or mcp. Repeat for several.

errorboolean nullable

true for only failed requests (status 400 or above), false for only successful ones.

min_occurredstring date-time nullable

Only requests received at or after this time, in ISO 8601.

max_occurredstring date-time nullable

Only requests received before this time, in ISO 8601.

cursorstring nullable

A cursor for pagination: the next_cursor from the previous page.

sizeinteger nullable

Number of results per page, between 1 and 200. Defaults to 20.

Response

A page of requests.

object'list' required

The object's type. Always list.

has_moreboolean required

Whether there are more results after this page.

next_cursorstring nullable required

The cursor for the next page. Send it as cursor. Null on the last page.

suppressedinteger required

The number of matching results withheld because the plan does not include them.

Example response

{
  "data": [
    {
      "request_id": "req_7872540bd07601eae287aa02",
      "method": "GET",
      "route": "/v1/parcel",
      "actor": {
        "name": "Production",
        "key": "0192f3a4-7d8e-7f90-b123-456789abcdef",
        "user": "0192f3a4-6c7d-7e8f-a012-3456789abcde",
        "client": "placestack-console"
      }
    }
  ],
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ"
}

Changes

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