GET /datasets
Description
Retrieve metadata for all datasets an App has permission to access for a given installation. These datasets are scoped to the installation ID provided to receive an access token.
If you want to retrieve the contents of a dataset, call the/records:retrieve
endpoint.
Parameters
No parameters.
URL Structure
https://app.movementinfrastructure.org/api/v1/datasets
Example Response Body
{
{
"metadata": {
"count": 2
},
"data": [
{
"datasetId": "111e3xam4-2345-67ple-abdc-89198jk2bz",
"name": "GOTV Dataset",
"description": "One of my many GOTV lists",
"dateCreated": "2024-08-19T14:29:52.229139",
"recordCount": 10000,
"dateLastRecordUpdated": null,
"createdBy": {
"userId": 11111,
"displayName": "My Test DXAPI App",
"email": ""
},
"createdByWorkspace": {
"workspaceId": 1235643,
"displayName": "Soledad for Governor"
},
"datasetTags": [
{
"datasetTagId": "a1nex7a-543m-8989-11p0-23le456789",
"name": "My Test DXAPI App",
"datasetId": "111e3xam4-2345-67ple-abdc-89198jk2bz",
"movementAppId": "789ex3a5-mpl3-43f0-e198-x45a9m58p1ee"
}
],
"datasetSchema": {
"datasetSchemaId": 456,
"properties": [
{
"type": "string",
"required": true,
"name": "van_id"
},
{
"type": "string",
"required": true,
"name": "first_name"
},
{
"type": "string",
"required": true,
"name": "last_name"
}
],
"primaryKey": [
"van_id"
]
}
},
{
"datasetId": "d280d9ce-7138-4978-a88d-dacb9641bd76",
"name": "October Door Knocking",
"description": "All of the doors for knocking",
"dateCreated": "2024-08-16T15:29:12.529512",
"recordCount": 10000,
"dateLastRecordUpdated": null,
"createdBy": {
"userId": 11111,
"displayName": "My Test DXAPI App",
"email": ""
},
"createdByWorkspace": {
"workspaceId": 1235643,
"displayName": "Soledad for Governor"
},
"datasetTags": [
{
"datasetTagId": "a1nex7a-543m-8989-11p0-23le456789",
"name": "My Test DXAPI App",
"datasetId": "111e3xam4-2345-67ple-abdc-89198jk2bz",
"movementAppId": "789ex3a5-mpl3-43f0-e198-x45a9m58p1ee"
}
],
"datasetSchema": {
"datasetSchemaId": 123,
"properties": [
{
"type": "string",
"required": true,
"name": "van_id"
},
{
"type": "string",
"required": true,
"name": "first_name"
},
{
"type": "string",
"required": true,
"name": "last_name"
},
{
"name": "knock_count",
"required": true,
"type": "integer"
},
{
"name": "answered_door",
"required": true,
"type": "boolean"
}
],
"primaryKey": [
"van_id"
]
}
}
]
}
Updated about 1 month ago
What’s Next