Skip to main content

APIKeyUsageListResponse

data object[]required
  • Array [
  • idstringrequired
    methodstringrequired

    HTTP method.

    pathstringrequired

    Request path.

    status_codeintegerrequired

    HTTP response status code.

    ip_addressstringnullable

    Client IP address.

    scope_usedPermissionScope

    The base permission vocabulary for an API key. A key is granted PermissionGrant values, which are these scopes optionally narrowed to a single domain.

    Possible values: [sending, emails:read, domains:manage, contacts:manage, webhooks:manage, analytics:read, api-keys:manage, suppressions:read, suppressions:manage, templates:read, templates:manage, inbound:read, inbound:manage, broadcasts:read, broadcasts:manage, broadcasts:send, *]

    created_atstring<date-time>required
  • ]
  • has_moreboolean
    next_cursorstring
    APIKeyUsageListResponse
    {
    "data": [
    {
    "id": "string",
    "method": "string",
    "path": "string",
    "status_code": 0,
    "ip_address": "string",
    "scope_used": "sending",
    "created_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "has_more": true,
    "next_cursor": "string"
    }