AdminApiMetricDataController_get

AdminApiMetricDataController_get

Header Parameters
PubNub-Version string — REQUIRED

Possible values: [2026-02-09]

Request Body — REQUIRED
name string — REQUIRED

Possible values: 1 ≤ length ≤ 50

Metric name (1-50 characters).

id string

PubNub-generated unique ID for the metric. Required in later requests to update, delete, or retrieve the metric.

businessObjectId string — REQUIRED

ID of the source business object.

measureId string

Field ID to aggregate (required for AVG, MAX, MIN, SUM functions). References a NUMERIC field from the business object.

evaluationWindow number — REQUIRED

Possible values: 1 ≤ value ≤ 86400

Time period in seconds for metric evaluation. Allowed values: 60 (1 min), 300 (5 min), 600 (10 min), 900 (15 min), 1800 (30 min), 3600 (1 hour), 86400 (1 day).

function string — REQUIRED

Possible values: [AVG, SUM, MAX, MIN, COUNT, COUNT_DISTINCT]

Aggregation function: AVG, COUNT, COUNT_DISTINCT, MAX, MIN, or SUM.

dimensionIds string[]

Field IDs to group by (TEXT fields only). References dimensions from the business object.

filters object[]

Filtering criteria for the metric.

id string

PubNub-generated ID for the metric filter. Required when updating a metric (PUT).

sourceType string — REQUIRED

Possible values: [MEASURE, DIMENSION]

Filter source type. Value must always be DIMENSION.

sourceId string — REQUIRED

ID of the field or data field to filter on.

operation string — REQUIRED

Possible values: [NUMERIC_GREATER_THAN, NUMERIC_GREATER_THAN_EQUALS, NUMERIC_LESS_THAN, NUMERIC_LESS_THAN_EQUALS, NUMERIC_INCLUSIVE_BETWEEN, NUMERIC_EXCLUSIVE_NOT_BETWEEN, BOOLEAN_IS_TRUE, BOOLEAN_IS_FALSE, STRING_CONTAINS, STRING_NOT_CONTAINS, STRING_STARTS_WITH, STRING_ENDS_WITH, STRING_EQUALS, STRING_IS_EMPTY, STRING_IS_NOT_EMPTY, STRING_NOT_EQUALS]

Filter operation: STRING_EQUALS, STRING_NOT_EQUAL, STRING_CONTAINS, STRING_NOT_CONTAINS, STRING_IS_EMPTY, STRING_IS_NOT_EMPTY, STRING_STARTS_WITH, STRING_ENDS_WITH.

arguments string[] — REQUIRED

Filter arguments (1 string). Matching is case-sensitive.

startDate date-time — REQUIRED
endDate date-time — REQUIRED
utcOffsetSec number
limit number

Possible values: 1 ≤ value ≤ 30

page number

Possible values: 1 ≤ value

includeMeta boolean
Responses
200
Schema — OPTIONAL
data object
meta object
allDimensionKeys string[] — OPTIONAL
* required
PubNub-Version*
Type: string
Possible values: [2026-02-09]
* required
name*
Type: string
Metric name (1-50 characters).
1-50 chars
id
Type: string
PubNub-generated unique ID for the metric. Required in later requests to update, delete, or retrieve the metric.
businessObjectId*
Type: string
ID of the source business object.
measureId
Type: string
Field ID to aggregate (required for AVG, MAX, MIN, SUM functions). References a NUMERIC field from the business object.
evaluationWindow*
Type: number
Time period in seconds for metric evaluation. Allowed values: 60 (1 min), 300 (5 min), 600 (10 min), 900 (15 min), 1800 (30 min), 3600 (1 hour), 86400 (1 day).
≥ 1, ≤ 86400
function*
Type: string
Aggregation function: AVG, COUNT, COUNT_DISTINCT, MAX, MIN, or SUM.
Enum (6 values)
View all values
"AVG""SUM""MAX""MIN""COUNT""COUNT_DISTINCT"
dimensionIds
Type: array
Field IDs to group by (TEXT fields only). References dimensions from the business object.
Array items:
items
Type: string
filters
Type: array
Filtering criteria for the metric.
Array items:
items
Type: object
startDate*
Type: string
Format: date-time
endDate*
Type: string
Format: date-time
utcOffsetSec
Type: number
limit
Type: number
≥ 1, ≤ 30
page
Type: number
≥ 1
includeMeta
Type: boolean
data
Type: object
meta
Type: object