You can use the activities API to create a dashboard to monitor the status of all your activities.
To create the dashboard, use the
status field to get all the open and closed activities,
and then aggregate the data using the platform of your choice. You can also use
the
closedOn field to get the activities that are going to
be closed.
Get all the open activities
Get all the activities that were deployed or scheduled for deployment.
Example
GET
https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/activities?status=open
- Scheduled activities
have a status of
open. At this time, you cannot filter activities that are in field from activities that are scheduled to be opened at a future date. For more information, see Scheduling. -
Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.
Get all the closed activities
Get all the activities that are currently closed.
Example
GET
https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/activities?status=closed
Get the activities that will be closed before a future date
You can use the activity's
closedOn field to help determine and display which
activities are set to be closed within a given time range in the dashboard.
Example
The following call will return all the activities that are set to be closed by the end of next month (assuming today's date is November 16, 2016):
GET
https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/activities?q="closedOn>="2016-11-16T00:00:00Z"
and closedOn<"2016-12-31T23:59:59Z""