/datasets/activity/{datasetId}

Retrieve information about a specific activity in your community.

Prerequisite

Resource URL

/v2/applications/{communityApiKeyName}/datasets/activity/{datasetId}
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 API Access.

Available methods

Method Description
GET Get information about an activity 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>,
    "name": <string name of the activity>,
    "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>
    }
}