HOhootsuite
Inbox

Inbound message volume

A count of inbound messages based on applied filters.

post/inbox/v1/reporting/metrics/inbound-message-volume

Request

  • Base URL
    https://platform.hootsuite.com
  • URL
    https://platform.hootsuite.com/inbox/v1/reporting/metrics/inbound-message-volume
  • Auth
    OAuth 2
    Authorization code: https://platform.hootsuite.com/oauth2/auth
    Token URL: https://platform.hootsuite.com/oauth2/token

Request body

fromstring required

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.

tostring

An ISO-8601 date time marking the exclusive end of the result. Must be URL encoded

timezonestring

The timezone to be used in conjunction withgroupByInterval, e.g. America/Los_Angeles. Must be URL encoded. If no timezone is provided, the default 'UTC' timezone is used

mediumIdsMediumId[]
channelIdsChannelId[]
groupByInterval'MINUTE' | 'HOUR' | 'DAY' | 'MONTH' | 'YEAR' | 'HOUR_BY_DAY'

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 longer than 1 hour

Response

Success

OR

Changes

No recorded changes to this operation across all 1 revision of this API.