Dashboards

Dashboards endpoints

Dashboards is the programmatic name of Quantive Results Insightboards. All endpoints in this group enable you to work programmatically with the insightboards in your account. Note that the Perfromance and Process reports are also dashboards, and are covered by this API as well.

🔗

get

/dashboards

Loads all dashboards using filter, sort and projection expressions coming from the request body

Parameters

Name	Type	Description

Expected response codes

`200`	`dashboardsResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v2/dashboards' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \


var settings = {
 "url": "https://app.quantive.com/results/api/v2/dashboards",
 "method": "GET",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
 }
};
$.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.quantive.com/results/api/v2/dashboards"



requests.get(url, headers = headers)

{
    "count": 2,
    "items": [
        {
            "access": {
                "inherits": false,
                "ownerPermissions": {
                    "deny": {
                        "Subtype": 2
                    },
                    "grant": {
                        "Subtype": 2
                    }
                },
                "permissions": [
                    {
                        "grant": {
                            "Subtype": 2
                        },
                        "principalId": "string",
                        "principalKind": "string value"
                    }
                ]
            },
            "appsCount": 2,
            "archived": false,
            "createdById": "string value",
            "currentUserAllowedActions": [
                "string value 1",
                "string value 2"
            ],
            "dateModified": "string value",
            "id": "string value",
            "insights": [
                {
                    "col": 2,
                    "dashboardId": "string value",
                    "filters": [
                        "string value 1",
                        "string value 2"
                    ],
                    "id": "string value",
                    "insightId": "string value",
                    "insightName": "string value",
                    "insightRequiredEntities": [
                        {
                            "dataSourceIds": [
                                "string value 1",
                                "string value 2"
                            ],
                            "entityName": "string value",
                            "isMissing": false,
                            "remoteEntityName": "string value"
                        }
                    ],
                    "insightSource": {
                        "originalVersion": "string value",
                        "sourceApplication": "string value"
                    },
                    "insightState": {
                        "error": "string value",
                        "metadata": {
                            "connectorName": "string value",
                            "count": 2,
                            "datasourceId": "string value",
                            "names": "string value",
                            "type": "string value"
                        },
                        "status": "string value"
                    },
                    "insightTitle": "string value",
                    "row": 2,
                    "settings": [
                        {
                            "dynamicValues": [
                                {
                                    "teamId": "string",
                                    "type": "string"
                                }
                            ],
                            "name": "string value",
                            "value": "string value",
                            "valueDisplayName": "string value",
                            "valueDisplayNameAsArray": [
                                "string value 1",
                                "string value 2"
                            ]
                        }
                    ],
                    "sizeX": 2,
                    "sizeY": 2,
                    "type": "string value"
                }
            ],
            "insightsCount": 2,
            "isReport": false,
            "layout": "string value",
            "name": "string value",
            "notificationsCount": 2,
            "parameters": [
                {
                    "defaultValue": "string value",
                    "entityName": "string value",
                    "entityTitleField": "string value",
                    "entityValueField": "string value",
                    "id": "string value",
                    "key": "string value",
                    "predefinedValues": [
                        "string value 1",
                        "string value 2"
                    ],
                    "selectorType": "string value",
                    "title": "string value"
                }
            ],
            "readOnly": false,
            "sectionHeaders": [
                {
                    "accountId": "string value",
                    "col": 2,
                    "dashboardId": "string value",
                    "id": "string value",
                    "row": 2,
                    "sectionHeader": {
                        "accountId": "string",
                        "createdById": "string",
                        "dateCreated": "string value",
                        "dateUpdated": "string value",
                        "header": "string value",
                        "id": "string",
                        "modifiedById": "string",
                        "subHeader": "string value"
                    },
                    "sectionHeaderId": "string value",
                    "sizeX": 2,
                    "sizeY": 2,
                    "type": "string value"
                }
            ],
            "sectionHeadersCount": 2,
            "settings": [
                {
                    "dynamicValues": [
                        {
                            "teamId": "string",
                            "type": "string"
                        }
                    ],
                    "name": "string value",
                    "value": "string value",
                    "valueDisplayName": "string value",
                    "valueDisplayNameAsArray": [
                        "string value 1",
                        "string value 2"
                    ]
                }
            ],
            "source": {
                "sourceApplication": "string value",
                "sourceId": "string value"
            },
            "tag": "string value",
            "tags": [
                {
                    "createdBy": "string",
                    "dateCreated": "string value",
                    "id": "string value",
                    "isActive": false,
                    "items": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "items": [
                                {
                                    "createdBy": "string",
                                    "dateCreated": "string value",
                                    "id": "string value",
                                    "isActive": false,
                                    "items": [
                                        {
                                            "createdBy": "ID",
                                            "dateCreated": "string value",
                                            "id": "string value",
                                            "isActive": false,
                                            "items": [
                                                "tagResponse"
                                            ],
                                            "name": "string value",
                                            "title": "string value"
                                        }
                                    ],
                                    "name": "string value",
                                    "title": "string value"
                                }
                            ],
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "name": "string value",
                    "title": "string value"
                }
            ],
            "usersCount": 2
        }
    ],
    "totalCount": 2
}

🔗

get

/dashboards/reports

Gets Performance and Process reports in the specified account.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`

Expected response codes

`200`	`reportDashboardResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


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


var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/reports",
 "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.quantive.com/results/api/v1/dashboards/reports"



requests.get(url, headers = headers)

[
    {
        "id": "string value",
        "name": "string value"
    }
]

🔗

get

/dashboards/tag/{tag}

Gets all dashboards with the specified tag.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
tag *	string	Specifies the tag of the dashboard that is to be retrieved. expected in path

Expected response codes

`200`	`dashboardResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


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


var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/tag/{tag}",
 "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.quantive.com/results/api/v1/dashboards/tag/{tag}"



requests.get(url, headers = headers)

{
    "access": {
        "inherits": false,
        "ownerPermissions": {
            "deny": {
                "Subtype": 2
            },
            "grant": {
                "Subtype": 2
            }
        },
        "permissions": [
            {
                "grant": {
                    "Subtype": 2
                },
                "principalId": "string",
                "principalKind": "string value"
            }
        ]
    },
    "appsCount": 2,
    "archived": false,
    "createdById": "string value",
    "currentUserAllowedActions": [
        "string value 1",
        "string value 2"
    ],
    "dateModified": "string value",
    "id": "string value",
    "insights": [
        {
            "col": 2,
            "dashboardId": "string value",
            "filters": [
                "string value 1",
                "string value 2"
            ],
            "id": "string value",
            "insightId": "string value",
            "insightName": "string value",
            "insightRequiredEntities": [
                {
                    "dataSourceIds": [
                        "string value 1",
                        "string value 2"
                    ],
                    "entityName": "string value",
                    "isMissing": false,
                    "remoteEntityName": "string value"
                }
            ],
            "insightSource": {
                "originalVersion": "string value",
                "sourceApplication": "string value"
            },
            "insightState": {
                "error": "string value",
                "metadata": {
                    "connectorName": "string value",
                    "count": 2,
                    "datasourceId": "string value",
                    "names": "string value",
                    "type": "string value"
                },
                "status": "string value"
            },
            "insightTitle": "string value",
            "row": 2,
            "settings": [
                {
                    "dynamicValues": [
                        {
                            "teamId": "string",
                            "type": "string"
                        }
                    ],
                    "name": "string value",
                    "value": "string value",
                    "valueDisplayName": "string value",
                    "valueDisplayNameAsArray": [
                        "string value 1",
                        "string value 2"
                    ]
                }
            ],
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "insightsCount": 2,
    "isReport": false,
    "layout": "string value",
    "name": "string value",
    "notificationsCount": 2,
    "parameters": [
        {
            "defaultValue": "string value",
            "entityName": "string value",
            "entityTitleField": "string value",
            "entityValueField": "string value",
            "id": "string value",
            "key": "string value",
            "predefinedValues": [
                "string value 1",
                "string value 2"
            ],
            "selectorType": "string value",
            "title": "string value"
        }
    ],
    "readOnly": false,
    "sectionHeaders": [
        {
            "accountId": "string value",
            "col": 2,
            "dashboardId": "string value",
            "id": "string value",
            "row": 2,
            "sectionHeader": {
                "accountId": "string",
                "createdById": "string",
                "dateCreated": "string value",
                "dateUpdated": "string value",
                "header": "string value",
                "id": "string",
                "modifiedById": "string",
                "subHeader": "string value"
            },
            "sectionHeaderId": "string value",
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "sectionHeadersCount": 2,
    "settings": [
        {
            "dynamicValues": [
                {
                    "teamId": "string",
                    "type": "string"
                }
            ],
            "name": "string value",
            "value": "string value",
            "valueDisplayName": "string value",
            "valueDisplayNameAsArray": [
                "string value 1",
                "string value 2"
            ]
        }
    ],
    "source": {
        "sourceApplication": "string value",
        "sourceId": "string value"
    },
    "tag": "string value",
    "tags": [
        {
            "createdBy": "string",
            "dateCreated": "string value",
            "id": "string value",
            "isActive": false,
            "items": [
                {
                    "createdBy": "string",
                    "dateCreated": "string value",
                    "id": "string value",
                    "isActive": false,
                    "items": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "items": [
                                {
                                    "createdBy": "string",
                                    "dateCreated": "string value",
                                    "id": "string value",
                                    "isActive": false,
                                    "items": [
                                        {
                                            "createdBy": "ID",
                                            "dateCreated": "string value",
                                            "id": "string value",
                                            "isActive": false,
                                            "items": [
                                                "tagResponse"
                                            ],
                                            "name": "string value",
                                            "title": "string value"
                                        }
                                    ],
                                    "name": "string value",
                                    "title": "string value"
                                }
                            ],
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "name": "string value",
                    "title": "string value"
                }
            ],
            "name": "string value",
            "title": "string value"
        }
    ],
    "usersCount": 2
}

🔗

get

/dashboards/tags/usages

Gets a list of tags applied to dashboards (Insightboards) and the corresponding dashboard IDs for each tag.

Dashboard tags that are not accessible for the current user are excluded from the list.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
fields	string	If you provide the fields parameter with a list of fields for the resource you are interested in separated by comas, only those fields will be returned in the document The 'id' and 'accountId' fields are needed to identify an object so they are always included. If any of the fields is a complex object with sub-fields you can specify which set to include using the 'parent-field-name{sub-field-names}' syntax. expected in query, sample value: `name,createdById,metrics{name,attainment}`

Expected response codes

`200`	`dashboardsTagsResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X GET 'https://app.quantive.com/results/api/v1/dashboards/tags/usages?fields=name,createdById,metrics{name,attainment}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/tags/usages?fields=name,createdById,metrics{name,attainment}",
 "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.quantive.com/results/api/v1/dashboards/tags/usages"



requests.get(url, headers = headers)

{
    "items": [
        {
            "dashboardsCount": 2,
            "dashboardsIds": [
                "string value 1",
                "string value 2"
            ],
            "tagName": "string value",
            "tagTitle": "string value"
        }
    ]
}

🔗

get

/dashboards/{dashboardId}

Gets a dashboard by its unique identifier (id).

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
dashboardId *	string	Specifies the unique identifier (id) of the dashboard. expected in path

Expected response codes

`200`	`dashboardResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


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


var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/{dashboardId}",
 "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.quantive.com/results/api/v1/dashboards/{dashboardId}"



requests.get(url, headers = headers)

{
    "access": {
        "inherits": false,
        "ownerPermissions": {
            "deny": {
                "Subtype": 2
            },
            "grant": {
                "Subtype": 2
            }
        },
        "permissions": [
            {
                "grant": {
                    "Subtype": 2
                },
                "principalId": "string",
                "principalKind": "string value"
            }
        ]
    },
    "appsCount": 2,
    "archived": false,
    "createdById": "string value",
    "currentUserAllowedActions": [
        "string value 1",
        "string value 2"
    ],
    "dateModified": "string value",
    "id": "string value",
    "insights": [
        {
            "col": 2,
            "dashboardId": "string value",
            "filters": [
                "string value 1",
                "string value 2"
            ],
            "id": "string value",
            "insightId": "string value",
            "insightName": "string value",
            "insightRequiredEntities": [
                {
                    "dataSourceIds": [
                        "string value 1",
                        "string value 2"
                    ],
                    "entityName": "string value",
                    "isMissing": false,
                    "remoteEntityName": "string value"
                }
            ],
            "insightSource": {
                "originalVersion": "string value",
                "sourceApplication": "string value"
            },
            "insightState": {
                "error": "string value",
                "metadata": {
                    "connectorName": "string value",
                    "count": 2,
                    "datasourceId": "string value",
                    "names": "string value",
                    "type": "string value"
                },
                "status": "string value"
            },
            "insightTitle": "string value",
            "row": 2,
            "settings": [
                {
                    "dynamicValues": [
                        {
                            "teamId": "string",
                            "type": "string"
                        }
                    ],
                    "name": "string value",
                    "value": "string value",
                    "valueDisplayName": "string value",
                    "valueDisplayNameAsArray": [
                        "string value 1",
                        "string value 2"
                    ]
                }
            ],
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "insightsCount": 2,
    "isReport": false,
    "layout": "string value",
    "name": "string value",
    "notificationsCount": 2,
    "parameters": [
        {
            "defaultValue": "string value",
            "entityName": "string value",
            "entityTitleField": "string value",
            "entityValueField": "string value",
            "id": "string value",
            "key": "string value",
            "predefinedValues": [
                "string value 1",
                "string value 2"
            ],
            "selectorType": "string value",
            "title": "string value"
        }
    ],
    "readOnly": false,
    "sectionHeaders": [
        {
            "accountId": "string value",
            "col": 2,
            "dashboardId": "string value",
            "id": "string value",
            "row": 2,
            "sectionHeader": {
                "accountId": "string",
                "createdById": "string",
                "dateCreated": "string value",
                "dateUpdated": "string value",
                "header": "string value",
                "id": "string",
                "modifiedById": "string",
                "subHeader": "string value"
            },
            "sectionHeaderId": "string value",
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "sectionHeadersCount": 2,
    "settings": [
        {
            "dynamicValues": [
                {
                    "teamId": "string",
                    "type": "string"
                }
            ],
            "name": "string value",
            "value": "string value",
            "valueDisplayName": "string value",
            "valueDisplayNameAsArray": [
                "string value 1",
                "string value 2"
            ]
        }
    ],
    "source": {
        "sourceApplication": "string value",
        "sourceId": "string value"
    },
    "tag": "string value",
    "tags": [
        {
            "createdBy": "string",
            "dateCreated": "string value",
            "id": "string value",
            "isActive": false,
            "items": [
                {
                    "createdBy": "string",
                    "dateCreated": "string value",
                    "id": "string value",
                    "isActive": false,
                    "items": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "items": [
                                {
                                    "createdBy": "string",
                                    "dateCreated": "string value",
                                    "id": "string value",
                                    "isActive": false,
                                    "items": [
                                        {
                                            "createdBy": "ID",
                                            "dateCreated": "string value",
                                            "id": "string value",
                                            "isActive": false,
                                            "items": [
                                                "tagResponse"
                                            ],
                                            "name": "string value",
                                            "title": "string value"
                                        }
                                    ],
                                    "name": "string value",
                                    "title": "string value"
                                }
                            ],
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "name": "string value",
                    "title": "string value"
                }
            ],
            "name": "string value",
            "title": "string value"
        }
    ],
    "usersCount": 2
}

🔗

post

/dashboards

Creates a new dashboard.

Parameters

Name Type Description

gtmhub-accountId

string

Specifies the ID of the gtmhub account.

expected in header, sample value:

5be26318e5274a0007f17f61

dashboard

object

Specifies the object representing a dashboard.

expected in body, sample value:

{
    "archived": false,
    "name": "OKR Performance",
    "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"",
    "tag": "phe6ery4o",
    "tags": [
        {
            "id": "string",
            "isActive": {
                "DateDeactivated": "string value",
                "IsActive": false
            },
            "name": "string value",
            "title": "string value"
        }
    ]
}

Expected response codes

`201`	`dashboardResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`409`	`conflict`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/dashboards' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -d '{"archived":false,"name":"OKR Performance","settings":"name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"","tag":"phe6ery4o","tags":[{"id":"string","isActive":{"DateDeactivated":"string value","IsActive":false},"name":"string value","title":"string value"}]}'


var body ={
    "archived": false,
    "name": "OKR Performance",
    "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"",
    "tag": "phe6ery4o",
    "tags": [
        {
            "id": "string",
            "isActive": {
                "DateDeactivated": "string value",
                "IsActive": false
            },
            "name": "string value",
            "title": "string value"
        }
    ]
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 },
 "data": body
};
$.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.quantive.com/results/api/v1/dashboards"

body =  {
    "archived": false,
    "name": "OKR Performance",
    "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"",
    "tag": "phe6ery4o",
    "tags": [
        {
            "id": "string",
            "isActive": {
                "DateDeactivated": "string value",
                "IsActive": false
            },
            "name": "string value",
            "title": "string value"
        }
    ]
};

requests.post(url, data=json.dumps(body), headers = headers)

{
    "access": {
        "inherits": false,
        "ownerPermissions": {
            "deny": {
                "Subtype": 2
            },
            "grant": {
                "Subtype": 2
            }
        },
        "permissions": [
            {
                "grant": {
                    "Subtype": 2
                },
                "principalId": "string",
                "principalKind": "string value"
            }
        ]
    },
    "appsCount": 2,
    "archived": false,
    "createdById": "string value",
    "currentUserAllowedActions": [
        "string value 1",
        "string value 2"
    ],
    "dateModified": "string value",
    "id": "string value",
    "insights": [
        {
            "col": 2,
            "dashboardId": "string value",
            "filters": [
                "string value 1",
                "string value 2"
            ],
            "id": "string value",
            "insightId": "string value",
            "insightName": "string value",
            "insightRequiredEntities": [
                {
                    "dataSourceIds": [
                        "string value 1",
                        "string value 2"
                    ],
                    "entityName": "string value",
                    "isMissing": false,
                    "remoteEntityName": "string value"
                }
            ],
            "insightSource": {
                "originalVersion": "string value",
                "sourceApplication": "string value"
            },
            "insightState": {
                "error": "string value",
                "metadata": {
                    "connectorName": "string value",
                    "count": 2,
                    "datasourceId": "string value",
                    "names": "string value",
                    "type": "string value"
                },
                "status": "string value"
            },
            "insightTitle": "string value",
            "row": 2,
            "settings": [
                {
                    "dynamicValues": [
                        {
                            "teamId": "string",
                            "type": "string"
                        }
                    ],
                    "name": "string value",
                    "value": "string value",
                    "valueDisplayName": "string value",
                    "valueDisplayNameAsArray": [
                        "string value 1",
                        "string value 2"
                    ]
                }
            ],
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "insightsCount": 2,
    "isReport": false,
    "layout": "string value",
    "name": "string value",
    "notificationsCount": 2,
    "parameters": [
        {
            "defaultValue": "string value",
            "entityName": "string value",
            "entityTitleField": "string value",
            "entityValueField": "string value",
            "id": "string value",
            "key": "string value",
            "predefinedValues": [
                "string value 1",
                "string value 2"
            ],
            "selectorType": "string value",
            "title": "string value"
        }
    ],
    "readOnly": false,
    "sectionHeaders": [
        {
            "accountId": "string value",
            "col": 2,
            "dashboardId": "string value",
            "id": "string value",
            "row": 2,
            "sectionHeader": {
                "accountId": "string",
                "createdById": "string",
                "dateCreated": "string value",
                "dateUpdated": "string value",
                "header": "string value",
                "id": "string",
                "modifiedById": "string",
                "subHeader": "string value"
            },
            "sectionHeaderId": "string value",
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "sectionHeadersCount": 2,
    "settings": [
        {
            "dynamicValues": [
                {
                    "teamId": "string",
                    "type": "string"
                }
            ],
            "name": "string value",
            "value": "string value",
            "valueDisplayName": "string value",
            "valueDisplayNameAsArray": [
                "string value 1",
                "string value 2"
            ]
        }
    ],
    "source": {
        "sourceApplication": "string value",
        "sourceId": "string value"
    },
    "tag": "string value",
    "tags": [
        {
            "createdBy": "string",
            "dateCreated": "string value",
            "id": "string value",
            "isActive": false,
            "items": [
                {
                    "createdBy": "string",
                    "dateCreated": "string value",
                    "id": "string value",
                    "isActive": false,
                    "items": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "items": [
                                {
                                    "createdBy": "string",
                                    "dateCreated": "string value",
                                    "id": "string value",
                                    "isActive": false,
                                    "items": [
                                        {
                                            "createdBy": "ID",
                                            "dateCreated": "string value",
                                            "id": "string value",
                                            "isActive": false,
                                            "items": [
                                                "tagResponse"
                                            ],
                                            "name": "string value",
                                            "title": "string value"
                                        }
                                    ],
                                    "name": "string value",
                                    "title": "string value"
                                }
                            ],
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "name": "string value",
                    "title": "string value"
                }
            ],
            "name": "string value",
            "title": "string value"
        }
    ],
    "usersCount": 2
}

🔗

post

/dashboards/{dashboardId}/clone

Clones an already existing dashboard.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
dashboardId *	string	Specifies the unique identifier (id) of the dashboard. expected in path
tag *	object	Specifies the dashboard tag for the cloned dashboard. expected in body, sample value: { "tag": "phe6ery4o" }

Expected response codes

`201`	`dashboardResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X POST 'https://app.quantive.com/results/api/v1/dashboards/{dashboardId}/clone' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -d '{"tag":"phe6ery4o"}'


var body ={
    "tag": "phe6ery4o"
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/{dashboardId}/clone",
 "method": "POST",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 },
 "data": body
};
$.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.quantive.com/results/api/v1/dashboards/{dashboardId}/clone"

body =  {
    "tag": "phe6ery4o"
};

requests.post(url, data=json.dumps(body), headers = headers)

{
    "access": {
        "inherits": false,
        "ownerPermissions": {
            "deny": {
                "Subtype": 2
            },
            "grant": {
                "Subtype": 2
            }
        },
        "permissions": [
            {
                "grant": {
                    "Subtype": 2
                },
                "principalId": "string",
                "principalKind": "string value"
            }
        ]
    },
    "appsCount": 2,
    "archived": false,
    "createdById": "string value",
    "currentUserAllowedActions": [
        "string value 1",
        "string value 2"
    ],
    "dateModified": "string value",
    "id": "string value",
    "insights": [
        {
            "col": 2,
            "dashboardId": "string value",
            "filters": [
                "string value 1",
                "string value 2"
            ],
            "id": "string value",
            "insightId": "string value",
            "insightName": "string value",
            "insightRequiredEntities": [
                {
                    "dataSourceIds": [
                        "string value 1",
                        "string value 2"
                    ],
                    "entityName": "string value",
                    "isMissing": false,
                    "remoteEntityName": "string value"
                }
            ],
            "insightSource": {
                "originalVersion": "string value",
                "sourceApplication": "string value"
            },
            "insightState": {
                "error": "string value",
                "metadata": {
                    "connectorName": "string value",
                    "count": 2,
                    "datasourceId": "string value",
                    "names": "string value",
                    "type": "string value"
                },
                "status": "string value"
            },
            "insightTitle": "string value",
            "row": 2,
            "settings": [
                {
                    "dynamicValues": [
                        {
                            "teamId": "string",
                            "type": "string"
                        }
                    ],
                    "name": "string value",
                    "value": "string value",
                    "valueDisplayName": "string value",
                    "valueDisplayNameAsArray": [
                        "string value 1",
                        "string value 2"
                    ]
                }
            ],
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "insightsCount": 2,
    "isReport": false,
    "layout": "string value",
    "name": "string value",
    "notificationsCount": 2,
    "parameters": [
        {
            "defaultValue": "string value",
            "entityName": "string value",
            "entityTitleField": "string value",
            "entityValueField": "string value",
            "id": "string value",
            "key": "string value",
            "predefinedValues": [
                "string value 1",
                "string value 2"
            ],
            "selectorType": "string value",
            "title": "string value"
        }
    ],
    "readOnly": false,
    "sectionHeaders": [
        {
            "accountId": "string value",
            "col": 2,
            "dashboardId": "string value",
            "id": "string value",
            "row": 2,
            "sectionHeader": {
                "accountId": "string",
                "createdById": "string",
                "dateCreated": "string value",
                "dateUpdated": "string value",
                "header": "string value",
                "id": "string",
                "modifiedById": "string",
                "subHeader": "string value"
            },
            "sectionHeaderId": "string value",
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "sectionHeadersCount": 2,
    "settings": [
        {
            "dynamicValues": [
                {
                    "teamId": "string",
                    "type": "string"
                }
            ],
            "name": "string value",
            "value": "string value",
            "valueDisplayName": "string value",
            "valueDisplayNameAsArray": [
                "string value 1",
                "string value 2"
            ]
        }
    ],
    "source": {
        "sourceApplication": "string value",
        "sourceId": "string value"
    },
    "tag": "string value",
    "tags": [
        {
            "createdBy": "string",
            "dateCreated": "string value",
            "id": "string value",
            "isActive": false,
            "items": [
                {
                    "createdBy": "string",
                    "dateCreated": "string value",
                    "id": "string value",
                    "isActive": false,
                    "items": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "items": [
                                {
                                    "createdBy": "string",
                                    "dateCreated": "string value",
                                    "id": "string value",
                                    "isActive": false,
                                    "items": [
                                        {
                                            "createdBy": "ID",
                                            "dateCreated": "string value",
                                            "id": "string value",
                                            "isActive": false,
                                            "items": [
                                                "tagResponse"
                                            ],
                                            "name": "string value",
                                            "title": "string value"
                                        }
                                    ],
                                    "name": "string value",
                                    "title": "string value"
                                }
                            ],
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "name": "string value",
                    "title": "string value"
                }
            ],
            "name": "string value",
            "title": "string value"
        }
    ],
    "usersCount": 2
}

🔗

put

/dashboards/items/{id}

Saves an insight (dashboardItem) on an insightboard (dashboard)

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
dashboardId *	string	Specifies the unique identifier (id) of the dashboard. expected in path
dashboard *	object	Specifies the object representing a dashboard. expected in body, sample value: { "archived": false, "name": "OKR Performance", "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"", "tag": "phe6ery4o", "tags": [ { "id": "string", "isActive": { "DateDeactivated": "string value", "IsActive": false }, "name": "string value", "title": "string value" } ] }

Expected response codes

`204`	`no content`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X PUT 'https://app.quantive.com/results/api/v1/dashboards/items/{id}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -d '{"archived":false,"name":"OKR Performance","settings":"name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"","tag":"phe6ery4o","tags":[{"id":"string","isActive":{"DateDeactivated":"string value","IsActive":false},"name":"string value","title":"string value"}]}'


var body ={
    "archived": false,
    "name": "OKR Performance",
    "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"",
    "tag": "phe6ery4o",
    "tags": [
        {
            "id": "string",
            "isActive": {
                "DateDeactivated": "string value",
                "IsActive": false
            },
            "name": "string value",
            "title": "string value"
        }
    ]
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/items/{id}",
 "method": "PUT",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 },
 "data": body
};
$.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.quantive.com/results/api/v1/dashboards/items/{id}"

body =  {
    "archived": false,
    "name": "OKR Performance",
    "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"",
    "tag": "phe6ery4o",
    "tags": [
        {
            "id": "string",
            "isActive": {
                "DateDeactivated": "string value",
                "IsActive": false
            },
            "name": "string value",
            "title": "string value"
        }
    ]
};

requests.put(url, data=json.dumps(body), headers = headers)

🔗

put

/dashboards/{dashboardId}

Updates the dashboard with the specified unique identifier (id).

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
dashboardId *	string	Specifies the unique identifier (id) of the dashboard. expected in path
dashboard *	object	Specifies the object representing a dashboard. expected in body, sample value: { "archived": false, "name": "OKR Performance", "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"", "tag": "phe6ery4o", "tags": [ { "id": "string", "isActive": { "DateDeactivated": "string value", "IsActive": false }, "name": "string value", "title": "string value" } ] }

Expected response codes

`200`	`dashboardResponse`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`404`	`not found`
`500`	`internal server error`


 curl -X PUT 'https://app.quantive.com/results/api/v1/dashboards/{dashboardId}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
   -d '{"archived":false,"name":"OKR Performance","settings":"name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"","tag":"phe6ery4o","tags":[{"id":"string","isActive":{"DateDeactivated":"string value","IsActive":false},"name":"string value","title":"string value"}]}'


var body ={
    "archived": false,
    "name": "OKR Performance",
    "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"",
    "tag": "phe6ery4o",
    "tags": [
        {
            "id": "string",
            "isActive": {
                "DateDeactivated": "string value",
                "IsActive": false
            },
            "name": "string value",
            "title": "string value"
        }
    ]
};

var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/{dashboardId}",
 "method": "PUT",
 "timeout": 0,
 "headers": {
   "Content-Type": "application/json",
   "Accept": "application/json",
   "Authorization": "Bearer {token}",
   "gtmhub-accountId": "5be26318e5274a0007f17f61",
 },
 "data": body
};
$.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.quantive.com/results/api/v1/dashboards/{dashboardId}"

body =  {
    "archived": false,
    "name": "OKR Performance",
    "settings": "name: \"session\", value: \"602d03d90f20d5000195c7b3\", valueDisplayName: \"Q2\"",
    "tag": "phe6ery4o",
    "tags": [
        {
            "id": "string",
            "isActive": {
                "DateDeactivated": "string value",
                "IsActive": false
            },
            "name": "string value",
            "title": "string value"
        }
    ]
};

requests.put(url, data=json.dumps(body), headers = headers)

{
    "access": {
        "inherits": false,
        "ownerPermissions": {
            "deny": {
                "Subtype": 2
            },
            "grant": {
                "Subtype": 2
            }
        },
        "permissions": [
            {
                "grant": {
                    "Subtype": 2
                },
                "principalId": "string",
                "principalKind": "string value"
            }
        ]
    },
    "appsCount": 2,
    "archived": false,
    "createdById": "string value",
    "currentUserAllowedActions": [
        "string value 1",
        "string value 2"
    ],
    "dateModified": "string value",
    "id": "string value",
    "insights": [
        {
            "col": 2,
            "dashboardId": "string value",
            "filters": [
                "string value 1",
                "string value 2"
            ],
            "id": "string value",
            "insightId": "string value",
            "insightName": "string value",
            "insightRequiredEntities": [
                {
                    "dataSourceIds": [
                        "string value 1",
                        "string value 2"
                    ],
                    "entityName": "string value",
                    "isMissing": false,
                    "remoteEntityName": "string value"
                }
            ],
            "insightSource": {
                "originalVersion": "string value",
                "sourceApplication": "string value"
            },
            "insightState": {
                "error": "string value",
                "metadata": {
                    "connectorName": "string value",
                    "count": 2,
                    "datasourceId": "string value",
                    "names": "string value",
                    "type": "string value"
                },
                "status": "string value"
            },
            "insightTitle": "string value",
            "row": 2,
            "settings": [
                {
                    "dynamicValues": [
                        {
                            "teamId": "string",
                            "type": "string"
                        }
                    ],
                    "name": "string value",
                    "value": "string value",
                    "valueDisplayName": "string value",
                    "valueDisplayNameAsArray": [
                        "string value 1",
                        "string value 2"
                    ]
                }
            ],
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "insightsCount": 2,
    "isReport": false,
    "layout": "string value",
    "name": "string value",
    "notificationsCount": 2,
    "parameters": [
        {
            "defaultValue": "string value",
            "entityName": "string value",
            "entityTitleField": "string value",
            "entityValueField": "string value",
            "id": "string value",
            "key": "string value",
            "predefinedValues": [
                "string value 1",
                "string value 2"
            ],
            "selectorType": "string value",
            "title": "string value"
        }
    ],
    "readOnly": false,
    "sectionHeaders": [
        {
            "accountId": "string value",
            "col": 2,
            "dashboardId": "string value",
            "id": "string value",
            "row": 2,
            "sectionHeader": {
                "accountId": "string",
                "createdById": "string",
                "dateCreated": "string value",
                "dateUpdated": "string value",
                "header": "string value",
                "id": "string",
                "modifiedById": "string",
                "subHeader": "string value"
            },
            "sectionHeaderId": "string value",
            "sizeX": 2,
            "sizeY": 2,
            "type": "string value"
        }
    ],
    "sectionHeadersCount": 2,
    "settings": [
        {
            "dynamicValues": [
                {
                    "teamId": "string",
                    "type": "string"
                }
            ],
            "name": "string value",
            "value": "string value",
            "valueDisplayName": "string value",
            "valueDisplayNameAsArray": [
                "string value 1",
                "string value 2"
            ]
        }
    ],
    "source": {
        "sourceApplication": "string value",
        "sourceId": "string value"
    },
    "tag": "string value",
    "tags": [
        {
            "createdBy": "string",
            "dateCreated": "string value",
            "id": "string value",
            "isActive": false,
            "items": [
                {
                    "createdBy": "string",
                    "dateCreated": "string value",
                    "id": "string value",
                    "isActive": false,
                    "items": [
                        {
                            "createdBy": "string",
                            "dateCreated": "string value",
                            "id": "string value",
                            "isActive": false,
                            "items": [
                                {
                                    "createdBy": "string",
                                    "dateCreated": "string value",
                                    "id": "string value",
                                    "isActive": false,
                                    "items": [
                                        {
                                            "createdBy": "ID",
                                            "dateCreated": "string value",
                                            "id": "string value",
                                            "isActive": false,
                                            "items": [
                                                "tagResponse"
                                            ],
                                            "name": "string value",
                                            "title": "string value"
                                        }
                                    ],
                                    "name": "string value",
                                    "title": "string value"
                                }
                            ],
                            "name": "string value",
                            "title": "string value"
                        }
                    ],
                    "name": "string value",
                    "title": "string value"
                }
            ],
            "name": "string value",
            "title": "string value"
        }
    ],
    "usersCount": 2
}

🔗

delete

/dashboards/{dashboardId}

Deletes the dashboard with the specified unique identifier (id).

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
dashboardId *	string	Specifies the unique identifier (id) of the dashboard. expected in path

Expected response codes

`204`	`no content`
`400`	`bad request`
`401`	`unauthorized`
`402`	`payment required`
`403`	`forbidden`
`500`	`internal server error`


 curl -X DELETE 'https://app.quantive.com/results/api/v1/dashboards/{dashboardId}' \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer {token}' \
   -H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \


var settings = {
 "url": "https://app.quantive.com/results/api/v1/dashboards/{dashboardId}",
 "method": "DELETE",
 "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.quantive.com/results/api/v1/dashboards/{dashboardId}"



requests.delete(url, headers = headers)

Oops! Looks like there are no API calls of that type for this Endpoint