Usage

Current-period usage and credit balance for the authenticated product key.

Get current API usage

GET

https://api.pokerworks.io

/api/v1/usage

List usage and credit balance for the authenticated product key

Get current API usage › query Parameters

limit

integer · min: 1 · max: 100

Maximum recent requests to return for the authenticated product-key environment current period. Defaults to 25.

Default: 25

Get current API usage › Responses

UsageSummaryResponse

balanceCredits

integer · required

creditsCharged

integer · min: 0 · required

environment

string · enum · required

Enum values:

test

live

organizationId

string · required

periodEnd

string · date-time · required

periodStart

string · date-time · required

projectId

string | null · required

object[] · required

totalRequests

integer · min: 0 · required

GET/api/v1/usage

curl https://api.pokerworks.io/api/v1/usage \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "balanceCredits": 0,
  "creditsCharged": 0,
  "environment": "test",
  "organizationId": "organizationId",
  "periodEnd": "2024-08-25T15:00:00Z",
  "periodStart": "2024-08-25T15:00:00Z",
  "projectId": "projectId",
  "recentRequests": [
    {
      "creditsCharged": 0,
      "endpoint": "endpoint",
      "environment": "test",
      "id": "id",
      "latencyMs": 0,
      "method": "method",
      "occurredAt": "2024-08-25T15:00:00Z",
      "operation": "operation",
      "productKeyId": "productKeyId",
      "projectId": "projectId",
      "requestId": "requestId",
      "statusCode": 0
    }
  ],
  "totalRequests": 0
}

json

application/json

Calculations Health

Get current API usage

GET

https://api.pokerworks.io

/api/v1/usage

List usage and credit balance for the authenticated product key

Get current API usage › query Parameters

limit

integer · min: 1 · max: 100

Maximum recent requests to return for the authenticated product-key environment current period. Defaults to 25.

Default: 25

Get current API usage › Responses

UsageSummaryResponse

balanceCredits

integer · required

creditsCharged

integer · min: 0 · required

environment

string · enum · required

Enum values:

test

live

organizationId

string · required

periodEnd

string · date-time · required

periodStart

string · date-time · required

projectId

string | null · required

object[] · required

totalRequests

integer · min: 0 · required