Reports endpoints

The reports endpoints enable you to get a report on a user or team's performance in a specified session.

🔗
get
/reports/team/{id}
Gets a report on team performance in active sessions.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
teamId
*
stringThe unique identifier (id) of the team.
expected in path
Expected response codes
200teamReport
401unauthorized

curl -X GET 'https://app.gtmhub.com/api/v1/reports/team/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \

var settings = { "url": "https://app.gtmhub.com/api/v1/reports/team/{id}", "method": "GET", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
}
}; $.ajax(settings).done(function (response) { console.log(response); });
 NOTE: You must install the module requests.
In a terminal window do: pip install requests



import requests, json

headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };

url = "https://app.gtmhub.com/api/v1/reports/team/{id}"



requests.get(url, headers = headers)
{
    "managerId": "string value",
    "managerName": "string value",
    "memberGoalStats": [
        {
            "accountId": "string value",
            "assignee": {
                "accountId": "string value",
                "avatar": "string value",
                "color": "string value",
                "dynamicValueType": "string value",
                "email": "string value",
                "id": "string value",
                "isActive": false,
                "name": "string value",
                "picture": "string value",
                "tags": [
                    {
                        "createdBy": "string",
                        "dateCreated": "string value",
                        "id": "string value",
                        "isActive": false,
                        "name": "string value",
                        "title": "string value"
                    }
                ],
                "type": "string value"
            },
            "assignees": [
                {
                    "accountId": "string value",
                    "avatar": "string value",
                    "color": "string value",
                    "dynamicValueType": "string value",
                    "email": "string value",
                    "id": "string value",
                    "isActive": false,
                    "name": "string value",
                    "picture": "string value",
                    "tags": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "type": "string value"
                }
            ],
            "dueIn": 2,
            "id": "string value",
            "metricsStats": [
                {
                    "accountId": "string value",
                    "dueIn": 2,
                    "goal_id": "string value",
                    "id": "string value",
                    "name": "string value",
                    "obfuscated": false,
                    "progress": 2
                }
            ],
            "name": "string value",
            "obfuscated": false,
            "progress": 2
        }
    ],
    "memberSessionStats": {
        "checkinCount": 2,
        "dynamicMetricCount": 2,
        "goalCount": 2,
        "manualMetricCount": 2,
        "metricCount": 2,
        "progress": 2
    },
    "members": [
        {
            "accountId": "string value",
            "firstName": "string value",
            "lastName": "string value",
            "userId": "string value"
        }
    ],
    "teamGoalStats": [
        {
            "accountId": "string value",
            "assignee": {
                "accountId": "string value",
                "avatar": "string value",
                "color": "string value",
                "dynamicValueType": "string value",
                "email": "string value",
                "id": "string value",
                "isActive": false,
                "name": "string value",
                "picture": "string value",
                "tags": [
                    {
                        "createdBy": "string",
                        "dateCreated": "string value",
                        "id": "string value",
                        "isActive": false,
                        "name": "string value",
                        "title": "string value"
                    }
                ],
                "type": "string value"
            },
            "assignees": [
                {
                    "accountId": "string value",
                    "avatar": "string value",
                    "color": "string value",
                    "dynamicValueType": "string value",
                    "email": "string value",
                    "id": "string value",
                    "isActive": false,
                    "name": "string value",
                    "picture": "string value",
                    "tags": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "type": "string value"
                }
            ],
            "dueIn": 2,
            "id": "string value",
            "metricsStats": [
                {
                    "accountId": "string value",
                    "dueIn": 2,
                    "goal_id": "string value",
                    "id": "string value",
                    "name": "string value",
                    "obfuscated": false,
                    "progress": 2
                }
            ],
            "name": "string value",
            "obfuscated": false,
            "progress": 2
        }
    ],
    "teamId": "string value",
    "teamName": "string value",
    "teamSessionStats": {
        "checkinCount": 2,
        "dynamicMetricCount": 2,
        "goalCount": 2,
        "manualMetricCount": 2,
        "metricCount": 2,
        "progress": 2
    }
}
🔗
get
/reports/user/{id}
Gets a report on user performance in active sessions.
Parameters
NameTypeDescription
gtmhub-accountId
*
stringSpecifies the unique identifier (id) of the Gtmhub account.
expected in header, sample value:
5be26318e5274a0007f17f61
id
*
stringThe ID of the user.
expected in path, sample value:
5be26318e5274a0007f17f61
Expected response codes
200userReport
401unauthorized

curl -X GET 'https://app.gtmhub.com/api/v1/reports/user/{id}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \

var settings = { "url": "https://app.gtmhub.com/api/v1/reports/user/{id}", "method": "GET", "timeout": 0, "headers": { "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Bearer {token}",
"gtmhub-accountId": "5be26318e5274a0007f17f61",
}
}; $.ajax(settings).done(function (response) { console.log(response); });
 NOTE: You must install the module requests.
In a terminal window do: pip install requests



import requests, json

headers = { "Authorization" : "Bearer {token}", "gtmhub-accountId" : "{accountId}", "Content-Type" : "application/json" };

url = "https://app.gtmhub.com/api/v1/reports/user/{id}"



requests.get(url, headers = headers)
{
    "accountId": "string value",
    "firstName": "string value",
    "goalStats": [
        {
            "accountId": "string value",
            "assignee": {
                "accountId": "string value",
                "avatar": "string value",
                "color": "string value",
                "dynamicValueType": "string value",
                "email": "string value",
                "id": "string value",
                "isActive": false,
                "name": "string value",
                "picture": "string value",
                "tags": [
                    {
                        "createdBy": "string",
                        "dateCreated": "string value",
                        "id": "string value",
                        "isActive": false,
                        "name": "string value",
                        "title": "string value"
                    }
                ],
                "type": "string value"
            },
            "assignees": [
                {
                    "accountId": "string value",
                    "avatar": "string value",
                    "color": "string value",
                    "dynamicValueType": "string value",
                    "email": "string value",
                    "id": "string value",
                    "isActive": false,
                    "name": "string value",
                    "picture": "string value",
                    "tags": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "type": "string value"
                }
            ],
            "dueIn": 2,
            "id": "string value",
            "metricsStats": [
                {
                    "accountId": "string value",
                    "dueIn": 2,
                    "goal_id": "string value",
                    "id": "string value",
                    "name": "string value",
                    "obfuscated": false,
                    "progress": 2
                }
            ],
            "name": "string value",
            "obfuscated": false,
            "progress": 2
        }
    ],
    "lastName": "string value",
    "sessionStats": {
        "checkinCount": 2,
        "dynamicMetricCount": 2,
        "goalCount": 2,
        "manualMetricCount": 2,
        "metricCount": 2,
        "progress": 2
    },
    "teams": [
        {
            "managerId": "string value",
            "managerName": "string value",
            "teamId": "string value",
            "teamName": "string value"
        }
    ],
    "userId": "string value"
}