Get Broadcast Messages

Last updated November 13, 2020

GET /broadcast/v1/broadcasts

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

For a given portal, return details on a set of broadcast messages (e.g. a tweet or Facebook post).

A "broadcast" is a specific social message posted to a single social network.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Optional Parameters How to use Description
Filter by status status=success - Query param Only include broadcasts in matching state (success, waiting, canceled, error_fatal)
Filter by created at since=1356036460644 Only include broadcasts created at or more recently than given timestamp (milliseconds from epoch)
Filter by channel withChannelKeys=Twitter:403551555 Only include broadcasts created on specific channels. To request multiple channels, include the withChannelKeys parameter multiple times
Limit number of results count=100 Only include specified number of results
Offset offset=100 Used to get the next set of results. Increment the offset by the number your using in the count parameter to get the next set of results.