/datasets/activity

Retrieve a catalog of all activities in your community.

Resource URL

/v2/applications/{communityApiKeyName}/datasets/activity

Note:

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.

Available methods

Method	Description
GET	Get a catalog of all the activities in your community.

Available fields

Element	Description
id	The string GUID of the activity.
meta	The meta element is a property container with the following elements: datasetType: The type of activity. Possible values are: survey: This is a Community survey. sparq1survey: This is a power survey. createdById: The user who created the activity. createdDate: The date-time UTC when the activity was created. closedDate: The date-time UTC when the activity was closed. Note: The closedDate element only appears if the survey has the status of Closed. status: The status of the activity. Possible values are: Open Closed allowMultipleResponses: A boolean value indicating whether users are allowed to respond to the survey multiple times. The default is false; the user can only respond to the survey one time.
name	The name of the activity.

Example

[
    {
        "id": <GUID of the activity 1>,
        "name": <string name of the activity 1>,
        "meta": {
            "datasetType": <survey|sparq1survey>,
            "createdById": <GUID of the user that created the activity>,
            "createdDate": <date-time UTC the survey was created>,
            "closedDate": <date-time UTC the survey closed>,
            "status": <Open|Closed>,
            "allowMultipleResponses": <True|False>
        }
    },
    {
        "id": <GUID of the activity 2>,
        "name": <string name of the activity 2>,
        "meta": {
            "datasetType": <survey|sparq1survey>,
            "createdById": <GUID of the user that created the activity>,
            "createdDate": <date-time UTC the survey was created>,
            "closedDate": <date-time UTC the survey closed>,
            "status": <Open|Closed>,
            "allowMultipleResponses": <True|False>
        }
    }
]

Parent topic: Activity Datasets