Read participations breakdown by Marketing Event external identifier
GET {{baseUrl}}/marketing/v3/marketing-events/participations/:externalAccountId/:externalEventId/breakdown?contactIdentifier=<string>&state=<string>&limit=10&after=<string>
Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
contactIdentifier | string | The identifier of the Contact. It may be email or internal id. | |
state | string | The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW | |
limit | number | The limit for response size. The default value is 10, the max number is 100 | |
after | string | The cursor indicating the position of the last retrieved item. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"associations":{"contact":{"contactId":"\u003cstring\u003e","email":"\u003cstring\u003e","firstname":"\u003cstring\u003e","lastname":"\u003cstring\u003e"},"marketingEvent":{"marketingEventId":"\u003cstring\u003e","name":"\u003cstring\u003e","externalAccountId":"\u003cstring\u003e","externalEventId":"\u003cstring\u003e"}},"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"attendanceState":"REGISTERED","occurredAt":"\u003clong\u003e","attendancePercentage":"\u003cstring\u003e","attendanceDurationSeconds":"\u003cinteger\u003e"}},{"associations":{"contact":{"contactId":"\u003cstring\u003e","email":"\u003cstring\u003e","firstname":"\u003cstring\u003e","lastname":"\u003cstring\u003e"},"marketingEvent":{"marketingEventId":"\u003cstring\u003e","name":"\u003cstring\u003e","externalAccountId":"\u003cstring\u003e","externalEventId":"\u003cstring\u003e"}},"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"attendanceState":"NO_SHOW","occurredAt":"\u003clong\u003e","attendancePercentage":"\u003cstring\u003e","attendanceDurationSeconds":"\u003cinteger\u003e"}}],"total":"\u003cinteger\u003e","paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}