Skip to main content
GET
List engagements
Post engagement monitoring requires a V2 workspace API key. Legacy V1 API keys are not supported by these endpoints. Monitors and their credits belong to the V2 workspace associated with the key.
List the individual reactions and comments of delivered engagers, newest detection first. Set limit from 1 to 100 (default 50) and pass the returned next_cursor unchanged; it is null on the last page. Only engagements of engagers delivered (and paid for) are returned. Each engagement has engager_id, type (reaction or comment), post_url, source_url (the followed source), post_author_url, comment (the comment text, or null for a reaction), occurred_at (when the person engaged, or null when unknown), and detected_at. Reading engagements spends no credits.

Next step

Use List engagers for one row per person.

Authorizations

Authorization
string
header
required

Use an Airscale workspace API key. Never expose the key in client-side code.

Path Parameters

monitor_id
string<uuid>
required

Query Parameters

limit
integer
default:50

Number of engagements to return, from 1 to 100. Defaults to 50.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from the preceding response. Send it unchanged.

Required string length: 1 - 200

Response

The requested engagement page.

engagements
object[]
required
next_cursor
string | null
required