Snapshots API methods allow you to view and export results from the snapshots you conduct within DX. You may want to store these results in a database of your own or simply archive them for safe keeping.
API Methods
snapshots.list
Display a list of all the snapshots that have been conducted along with some basic data about each one.
Example
curl -X GET https://api.getdx.com/snapshots.list \
--header 'Authorization: Bearer <your-token>' \
{
"ok": true,
"snapshots": [
{
"id": "MjUyNbaY",
"account_id": "ABCD",
"last_result_change_at": "2024-07-18T15:47:12.080Z",
"scheduled_for": "2024-06-16",
"completed_at": "2024-07-01T14:01:51.027Z",
"completed_count": 3077,
"deleted_at": null,
"total_count": 3686
},
{
"id": "MTY5NwTaY",
"account_id": "ABCD",
"last_result_change_at": "2023-11-01T08:19:50.105Z",
"scheduled_for": "2023-10-01",
"completed_at": "2023-10-16T11:43:18.382Z",
"completed_count": 3321,
"deleted_at": null,
"total_count": 3580
}
]
}
snapshots.get
This endpoint returns a list of snapshot results by team. If there are results from a team with fewer than 3 contributors, then that data is not included.
To get the snapshot_id to include in the parameters, use the snapshots.list function above.
Example
curl -X GET https://api.getdx.com/snapshots.get?snapshot_id=<SNAPSHOT_ID> \
--header 'Authorization: Bearer <your-token>' \
{
"ok": true,
"snapshot": {
"team_scores": [
{
"snapshot_team": {
"id": "NTIzMTM",
"name": "Integrations",
"team_id": "NTA1ODg",
"parent": false,
"parent_id": "NTIxNDc",
"ancestors": [
"LTE",
"NTIzMTM",
"NTIxNDc",
"NTIwODI",
"NTIwNzE"
]
},
"item_id": "MTQ2",
"item_type": "factor",
"item_name": "Ease of release",
"response_count": 1,
"score": 0,
"contributor_count": 5,
"vs_prev": 0,
"vs_org": -68,
"vs_50th": -54,
"vs_75th": -68,
"vs_90th": -83
},
{
"snapshot_team": {
"id": "NTI5Njc",
"name": "Analytics",
"team_id": "NTA1OTI",
"parent": false,
"parent_id": "NTI1ODM",
"ancestors": [
"LTE",
"NTI5Njc",
"NTI1ODM",
"NTI0NTQ",
"NTI0MjQ"
]
},
"item_id": "MTQ2",
"item_type": "factor",
"item_name": "Ease of release",
"response_count": 3,
"score": 100,
"contributor_count": 10,
"vs_prev": 25,
"vs_org": 32,
"vs_50th": 46,
"vs_75th": 32,
"vs_90th": 17
},
{
"snapshot_team": {
"id": "NTI0MjY",
"name": "Machine Learning",
"team_id": "NTA1OTM",
"parent": true,
"parent_id": "NTI0MjQ",
"ancestors": [
"LTE",
"NTI0MjY",
"NTI0MjQ"
]
},
"item_id": "MTQ2",
"item_type": "factor",
"item_name": "Ease of release",
"response_count": 210,
"score": 60,
"contributor_count": 363,
"vs_prev": 2,
"vs_org": -8,
"vs_50th": 6,
"vs_75th": -8,
"vs_90th": -23
},
]
}
}
snapshots.comments.list
Retrieve a list of all important snapshot comments created within the last 90 days.
Example
curl -X GET "https://api.getdx.com/snapshots.comments.list" \
--header "Authorization: Bearer <your-token>"
{
"ok": true,
"comments": [
{
"email": "[email protected]",
"text": "Hoping to spread more of this knowledge through documentation.",
"timestamp": "1747162878.402226"
},
{
"email": "[email protected]",
"text": "I think more unit tests would help alleviate regressions here.",
"timestamp": "1747162878.402226"
},
{
"email": "[email protected]",
"text": "This has already been discussed, but I'd love to see a faster deployment process.",
"timestamp": "1747166595.447995"
},
{
"email": "[email protected]",
"text": "We're doing so much better here. I still feel like we can take the next step into observability and monitoring.",
"timestamp": "1747161593.913398"
}
]
}
snapshots.getLatestFile
This endpoint will download a full .xlsx file with all the snapshot results from the most recent snapshot, broken down by team.
curl -X GET https://api.getdx.com/snapshots.getLatestFile \
--header 'Authorization: Bearer <your-token>' \
snapshots.getFile
This endpoint will download a full .xlsx file with all the snapshot results by snapshot ID. Snapshots must be completed, and not in progress.
Parameters
Name | type | Required | Description |
snapshot_id | string | Yes | The ID |
curl -X GET https://api.getdx.com/snapshots.getFile?snapshot_id=ABC123 \
--header 'Authorization: Bearer <your-token>' \