Zoom Public API Documentation
Get deal activities
GET {{baseUrl}}/iq/deals/:dealId/activities?conversation_topic=<string>&callout_type=engagingQuestions&indicator_id=<string>&mentioned_topic_id=<string>&page_size=30&next_page_token=<string>
Get activities for a specific deal. Scopes: Rate Limit Label: iq_deal:read:admin,iq_deal:readMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
conversation_topic
|
string | The conversation topic | |
callout_type
|
string | The callout type of conversations to query: * `engagingQuestions` — Only query conversations that include engaging questions indicator. * `nextSteps` — Only query conversations that include next steps indicator. | |
indicator_id
|
string | The indicator id to query. | |
mentioned_topic_id
|
string | The mentioned topic id to query. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"activities": [
{
"conversation_topic": "<string>",
"deal_stage": "<string>",
"sentiment_score": "<integer>",
"engagement_score": "<integer>",
"host_id": "<string>",
"direction": "<string>",
"start_date": "<string>",
"activity_type": "<string>",
"stage_during_conversation": "<string>",
"processing_analysis": "<boolean>",
"message_ids": "<string>",
"number_of_message_in_thread": "<integer>",
"conversation_id": "<string>",
"duration": "<integer>"
},
{
"conversation_topic": "<string>",
"deal_stage": "<string>",
"sentiment_score": "<integer>",
"engagement_score": "<integer>",
"host_id": "<string>",
"direction": "<string>",
"start_date": "<string>",
"activity_type": "<string>",
"stage_during_conversation": "<string>",
"processing_analysis": "<boolean>",
"message_ids": "<string>",
"number_of_message_in_thread": "<integer>",
"conversation_id": "<string>",
"duration": "<integer>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/iq/deals/:dealId/activities?conversation_topic=<string>&callout_type=engagingQuestions&indicator_id=<string>&mentioned_topic_id=<string>&page_size=30&next_page_token=<string>?conversation_topic=<string>&callout_type=engagingQuestions&indicator_id=<string>&mentioned_topic_id=<string>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS