Skip to content
Admin SDK

GetAPIStatisticsParams

Defined in: src/types/api_statistics.ts:41

Query parameters for retrieving API usage statistics.

Properties

Section titled “Properties”

aggregate?

Section titled “aggregate?”

optional aggregate?: string

Defined in: src/types/api_statistics.ts:55

Aggregation measure (e.g. count).

aggregation_interval?

Section titled “aggregation_interval?”

optional aggregation_interval?: string

Defined in: src/types/api_statistics.ts:57

Aggregation interval aligned with dashboard stats (e.g. day, week).

api?

Section titled “api?”

optional api?: string

Defined in: src/types/api_statistics.ts:49

api_path?

Section titled “api_path?”

optional api_path?: string

Defined in: src/types/api_statistics.ts:45

Filter by API path for GET /admin/api_stats (query key api_path).

end_time?

Section titled “end_time?”

optional end_time?: number

Defined in: src/types/api_statistics.ts:65

End of the time range as a Unix timestamp (seconds).

fw_version?

Section titled “fw_version?”

optional fw_version?: string

Defined in: src/types/api_statistics.ts:53

Filter by node firmware version.

group_by?

Section titled “group_by?”

optional group_by?: string

Defined in: src/types/api_statistics.ts:69

Group results (e.g. api_path, user).

method?

Section titled “method?”

optional method?: string

Defined in: src/types/api_statistics.ts:51

Filter by HTTP method.

num_records?

Section titled “num_records?”

optional num_records?: string | number

Defined in: src/types/api_statistics.ts:59

Maximum number of records to return per page.

start_id?

Section titled “start_id?”

optional start_id?: string

Defined in: src/types/api_statistics.ts:61

Pagination cursor from the previous response (next_id).

start_time?

Section titled “start_time?”

optional start_time?: number

Defined in: src/types/api_statistics.ts:63

Start of the time range as a Unix timestamp (seconds).

timezone?

Section titled “timezone?”

optional timezone?: string

Defined in: src/types/api_statistics.ts:67

Timezone for the statistics data.