Get Events in Scope
To get the leads in scope for a particular Group, Chapter, or Channel, use one of the following REST APIs:
If events from all the groups are required, use only the required zone_id param:
https://{subdomain}.teleskope.io/1/eai/graph?getEventsInScope&zone_id={zone_id}
If events from a specific group is required, use the relevant encoded group_id param:
https://{subdomain}.teleskope.io/1/eai/graph?getEventsInScope&zone_id={zone_id}&group_id={group_id}
https://{subdomain}.teleskope.io/1/eai/graph?getEventsInScope&zone_id={zone_id}&group_id={group_id}&chapter_id={chapter_id}
https://{subdomain}.teleskope.io/1/eai/graph?getEventsInScope&zone_id={zone_id}&group_id={group_id}&channel_id={channel_id}
Replace {subdomain} with the customer's assigned subdomain, {group_id} with the Group ID obtained from the previous API call, {chapter_id} with the Chapter ID obtained from the previous API call (optional), and {channel_id} with the Channel ID obtained from the previous API call (optional). These APIs return a list of members in scope for the specified Group, Chapter, or Channel. Note:
- Zone_id: It is a required attribute.
- group_id: It is an optional attribute.
- To get events for all groups and admin level events in the specified zone, do not set the group_id attribute in the url.
- To get events for a specific group in the zone, set the group_id attribute in the url
- To get admin level events in the zone, set group_id to 0 or empty/no value.
- chapter_id: It is an optional attribute.
- To get events for all chapters in the group, including events that do not have chapters associated with them, do not set the chapter_id attribute in the url.
- To get events for a specific chapter in the group, set the chapter_id attribute in the url.
- To get global group level events only, i.e. events that do not have chapters associated with them, set chapterid to 0 or empty/no value.
- channel_id: It is an optional attribute.
- To get events for all channels in the group, including events that do not have channels associated with them, do not set the channel_id attribute in the url.
- To get events for a specific channel in the group, set the channe_id attribute in the url.
- To get global group level events only, i.e. events that do not have channels associated with them, set channel_id to 0 or empty/no value.
Return Values: Most of the returned attributes are self explanatory with additional details for some of the attributes listed below:
- created_at: A UTC date timestamp when the event record was created in the system.
- publish_at: A UTC date timestamp when the event was published or is scheduled to be published (events can be scheduled to be published 30 days in the future).
- modified_at: A UTC date timestamp when the event was last modified.
- canceled_at: A UTC date timestamp when the event was canceled, it is available only for canceled events.
- event_timezone: Timezone set for the event
- event_url: A unique URL to access the event in the Teleskope platform.
