Rehive logo
Powered by Redocly

metrics

List metrics

SecurityapiAuth
Request
query Parameters
archived
boolean
created
string <date-time>
created__gt
string <date-time>
created__gte
string <date-time>
created__lt
string <date-time>
created__lte
string <date-time>
currency
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

section
string
slug
string
slug__in
string
type
string
user
string
Responses
200
get/3/admin/metrics/
Request samples 
rehive.admin.metrics.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Create metric

SecurityapiAuth
Request
Request Body schema:
required
name
string or null <= 50 characters
slug
string or null <= 50 characters
type
required
string
  • account_count - Account Count
  • transaction_count - Transaction Count
  • transaction_complete_count - Transaction Complete Count
  • transaction_failed_count - Transaction Failed Count
  • transaction_pending_count - Transaction Pending Count
  • transaction_complete_sum - Transaction Complete Sum
  • transaction_failed_sum - Transaction Failed Sum
  • transaction_pending_sum - Transaction Pending Sum
  • transaction_balance_sum - Transaction Balance Sum
  • transaction_available_balance_sum - Transaction Available Balance Sum
  • user_count - User Count
  • user_active_count - User Active Count
  • user_transacted_in_30days_count - User Transacted In 30Days Count
Enum: "account_count" "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" "user_transacted_in_30days_count"
method
string
  • accumulate - Accumulate
  • set - Set
Enum: "accumulate" "set"
currency
string
timezone
required
string
object or null
object or null
user
string
section
required
string
  • admin - Admin
  • user - User
Enum: "admin" "user"
Responses
202
post/3/admin/metrics/
Request samples
{
  • "name": "string",
  • "slug": "string",
  • "type": "account_count",
  • "method": "accumulate",
  • "currency": "string",
  • "timezone": "string",
  • "query": {
    },
  • "metadata": {
    },
  • "user": "string",
  • "section": "admin"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Retrieve metric

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
get/3/admin/metrics/{identifier}/
Request samples 
rehive.admin.metrics.get({"id": metricIdentifier})
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

Delete metric

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
Responses
200
delete/3/admin/metrics/{identifier}/
Request samples 
rehive.admin.metrics.delete(metricIdentifier).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "string"
}

List metric points

SecurityapiAuth
Request
path Parameters
identifier
required
string^[a-zA-Z0-9\_\-]+$
query Parameters
date
string <date-time>
date__gt
string <date-time>
date__gte
string <date-time>
date__lt
string <date-time>
date__lte
string <date-time>
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/3/admin/metrics/{identifier}/points/
Request samples 
rehive.admin.metrics.points.get(metricIdentifier)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{}
➔ Next to oauth-clients