/datasets/{datasetId}/records (DEPRECATED)

Get a collection of records for a dataset.

Important: The Batch Data Extract and Dataset V2 endpoints should be used instead of the Datasets endpoints.
  • Batch Data Extract endpoints return a complete export of activity and profile variable data.
  • Datasets V2 endpoints allows you to select specific activities or profile variables.

Resource URL

/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records

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 Returns a collection of records.

Parameters

Parameters can be appended to the request to further refine the results returned.

Operation Description Example

Refine the response by field

To reduce the number of fields returned, specify the fields in a comma separated list.

You can filter the response on the following fields:
  • dataTimestamp
  • id
  • values
/datasets/{datasetId}/records?fields=values
Filtering by value By default, all the items are returned unless you specify your criteria using the variable name and value.
You can filter the response on the values in the following fields:
  • createDate
  • dataTimestamp
    Tip: For the most accurate response date, use the createDate and lastUpdateDate fields to filter the response.
  • id
  • lastUpdateDate
/datasets/{datasetId}/records?id=<GUID>
Paging The default is 20 items returned at a time and the maximum is 1000. Use the limit and offset query string parameters to effectively page through the results.
Sorting You can sort the response on the dataTimestamp field. /datasets/{datasetId}/records?sort=dataTimestamp:d

For more information, see Content control.

Available fields

Field Description
id The GUID for the record in the dataset.
createDate The date-time (UTC) the record was created.
dataTimestamp The timestamp for the date the record was created in Community.
Note: If the data was migrated from Sparq 1, then the value is the date the record was created in Community, not Sparq 1.
Tip: This field is to be deprecated. For the most accurate response date, use the createDate and lastUpdateDate.
lastUpdateDate The date timestamp (UTC) for when the record was last updated.
values The GUID and value for the column in the dataset.
  • columnId: The GUID for the column in the dataset
  • value: The value ID
    Note:
    • The value is a GUID for Community surveys.
    • The value is an integer for Community power surveys.
GET response structure


{
    "meta": {
        "offset": 0,
        "limit": 2,
        "count": 8
    },
    "items": [
        {
            "id": "GUID of record",
            "dataTimestamp": "date-time (UTC)",
            "createDate": "date-time (UTC)",
            "lastUpdateDate": "date-time (UTC)",
            "values": [
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                }
            ]
        },
        {
            "id": "GUID of record",
            "dataTimestamp": "date-time (UTC)",
            "createDate": "date-time (UTC)",
            "lastUpdateDate": "date-time (UTC)",
            "values": [
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": "value of column"
                },
                {
                    "columnId": "GUID of column",
                    "value": value of column
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "first",
            "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records?offset=0&limit=2"
        },
        {
            "rel": "prev",
            "href": null
        },
        {
            "rel": "last",
            "href": null
        },
        {
            "rel": "next",
            "href": null
        }
    ],
    "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records"
}