How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hootsuite Real Time Metrics Rest API

When calling the Real-time Metrics API, the client needs to be authenticated.The [REST API authentication](#tag/rest-api-authentication) section contains more details on how to authenticate your client.

Hootsuite Real Time Metrics Rest API is one of 21 APIs that Hootsuite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 9 operations across 9 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://platform.hootsuite.com.

9 operations 9 paths 18 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://platform.hootsuite.com/v1
Authentication
HTTP Bearer, HTTP Basic, OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 4

Hootsuite Real Time Metrics Rest API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearer-token). It accepts HTTP basic authentication (basic-auth). It supports OAuth 2.0 (Oauth2ClientCredentials) using the clientCredentials flow, exposing 1 scope. An API key is passed in the header as X-Hootsuite-Signature (SharedSecret). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.

real_time_metrics_rest_api 9

When calling the Real-time Metrics API, the client needs to be authenticated. The [REST API authentication](tag/rest-api-authentication) section contains more details on how to au…

POST
/inbox/v1/reporting/metrics/inbound-message-volume
Inbound message volume
metricsInboundMessageVolume body → 200401
POST
/inbox/v1/reporting/metrics/outbound-message-volume
Outbound message volume
metricsOutboundMessageVolume body → 200401
POST
/inbox/v1/reporting/metrics/first-response-time
Average first response time
metricsAverageFirstResponseTime body → 200401
POST
/inbox/v1/reporting/metrics/conversation-response-time
Average conversation response time
metricsAverageConversationResponseTime body → 200401
POST
/inbox/v1/reporting/metrics/resolved-with-one-reply
Resolved with reply
metricsResolvedWithReply body → 200401
POST
/inbox/v1/reporting/metrics/handle-time
Average handle time
metricsAverageHandleTime body → 200401
POST
/inbox/v1/user-presence/metrics/agent-availability
Agent availability
metricsAgentAvailability body → 200401
POST
/inbox/v1/queue/metrics/contacts-waiting
Contacts waiting in queue
metricsContactsWaitingInQueue body → 200401
POST
/inbox/v1/queue/metrics/longest-wait-time
Longest wait time in queue
metricsLongestWaitTimeInQueue body → 200401

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ResponseTimeRequest (8 properties), HandleTimeRequest (6 properties), TotalMessagesRequest (6 properties), TotalResolvedConversationsRequest (6 properties). Each schema is shown below with its type and property counts.

GroupByInterval
string
An interval to group results by. No more than 60 intervals can be requested per request. For example, when selecting minute, the requested time range cannot be…
From
string
An ISO-8601 date time marking the inclusive start of the result. Must be URL encoded. The from filter can be a maximum of 14 days in the past.
ChannelId
string
Filter by channel identifier (to obtain a list of your channel IDs, contact a Inbox 2.0 representative)
TotalResolvedConversationsRequest
object
6 properties 1 required
Timezone
string
The timezone to be used in conjunction withgroupByInterval, e.g. America/LosAngeles. Must be URL encoded. If no timezone is provided, the default 'UTC' timezon…
AgentAvailabilityRequest
object
2 properties
TotalMessagesRequest
object
6 properties 1 required
MetricRequest
object
5 properties 1 required
UserId
string
Filter by user identifier
MediumId
string
Filter by medium identifier
ResponseTimeRequest
object
8 properties 1 required
TeamId
string
Filter by team identifier
To
string
An ISO-8601 date time marking the exclusive end of the result. Must be URL encoded
TimeSeriesMetricResponse
object
1 property
TimeSeriesDataPoint
object
2 properties
HandleTimeRequest
object
6 properties 1 required
GroupedMetricResponse
object
1 property
NumberMetricResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hootsuite-real-time-metrics-rest-api-api-openapi.yml Raw ↑

Other APIs Hootsuite publishes across the network.

Hootsuite Developer Documentation MCP
Hootsuite Analytics API
Hootsuite Authentication API
Hootsuite Comments API
Hootsuite CRM Rest API
Hootsuite CRM Webhooks API
Hootsuite Me API
Hootsuite Media API
Hootsuite Members API
Hootsuite Messages API
Hootsuite Organizations API
Hootsuite Proactive Messaging Rest API
Where this information came from

This is an independent, third-party profile of Hootsuite Real Time Metrics Rest API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.