Metrics

List metric

SecurityToken
Request
query Parameters
slug
string
created
string
created__lt
string
created__gt
string
created__lte
string
created__gte
string
type
string
slug__in
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/metrics/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Create metric

SecurityToken
Request
Request Body schema: application/json
name
string or null (Name) <= 50 characters
slug
string or null (Slug) <= 50 characters
type
required
string (Type)
Enum: "transaction_count" "transaction_complete_count" "transaction_failed_count" "transaction_pending_count" "transaction_complete_sum" "transaction_failed_sum" "transaction_pending_sum" "transaction_balance_sum" "transaction_available_balance_sum" "user_count" "user_active_count"
currency
string (Currency) non-empty
timezone
required
string (Timezone)
query
object or null (Query)
metadata
object or null (Metadata)
Responses
201
post/metrics/
Request samples
application/json
{
  • "name": "string",
  • "slug": "string",
  • "type": "transaction_count",
  • "currency": "string",
  • "timezone": "string",
  • "query": { },
  • "metadata": { }
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve metric

SecurityToken
Request
path Parameters
identifier
required
string
Responses
200
get/metrics/{identifier}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Delete metric

SecurityToken
Request
path Parameters
identifier
required
string
Responses
204
delete/metrics/{identifier}/
Response samples
application/json
{
  • "status": "string"
}

List metric points

SecurityToken
Request
path Parameters
identifier
required
string
query Parameters
date
string
date__lt
string
date__gt
string
date__lte
string
date__gte
string
interval
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/metrics/{identifier}/points/
Response samples
application/json
{}