Yapper Docs
Api reference
GET
/usage/metadata

Credits per value of one metadata key given at POST /processes, net of refunds: with metadata.client on every start, key=client is the cost per client. Covers the processes the key's member can read (the whole workspace for owners and admins). Values are returned as text. Up to 500 values, highest spend first.

Authorization

bearerAuth usage:read
AuthorizationBearer <token>

In: header

Scope: usage:read

Query Parameters

key*string
Match^[A-Za-z0-9_-]{1,64}$
range?string
Default"month"

Value in

  • "week"
  • "month"
  • "quarter"
  • "year"
  • "all"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/usage/metadata?key=string"
{  "data": [    {      "value": "string",      "credits": 0,      "processes": 0    }  ],  "key": "string",  "range": "week",  "rangeStart": "2019-08-24T14:15:22Z",  "rangeEnd": "2019-08-24T14:15:22Z",  "truncated": true}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}