Dashboardparameters

Dashboardparameters endpoints

Dashboardparameters is the Quantive Results API representation of Insightboard parameters, also knows as Insightboard filters. For more information about Insightboard parameters refer to our help article Create Insightboard parameters. With the endpoints in this group you can get, update or create new Insightboard parameters, which can then be used in your Quantive Results Insights.

🔗

get

/dashboards/parameters

Gets all dashboard parameters for the specified accountId.

Parameters

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

Expected response codes

`200`	`dashboardParameterResponse`
`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/parameters' \
   -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/parameters",
 "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/parameters"



requests.get(url, headers = headers)

{
    "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"
}

🔗

get

/dashboards/parameters/{parameterId}

Gets a dashboard parameter definition.

Parameters

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

Expected response codes

`200`	`dashboardParameterResponse`
`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/parameters/{parameterId}' \
   -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/parameters/{parameterId}",
 "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/parameters/{parameterId}"



requests.get(url, headers = headers)

{
    "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"
}

🔗

post

/dashboards/parameters

Creates a new dashboard parameter.

Parameters

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

Expected response codes

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


 curl -X POST 'https://app.quantive.com/results/api/v1/dashboards/parameters' \
   -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/parameters",
 "method": "POST",
 "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/parameters"



requests.post(url, headers = headers)

{
    "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"
}

🔗

put

/dashboards/parameters/{parameterId}

Updates an already existing dashboard parameter.

Parameters

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

Expected response codes

`200`	`dashboardParameterResponse`
`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/parameters/{parameterId}' \
   -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/parameters/{parameterId}",
 "method": "PUT",
 "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/parameters/{parameterId}"



requests.put(url, headers = headers)

{
    "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"
}

🔗

delete

/dashboards/parameters/{parameterId}

Deletes the specified dashboard parameter.

No request body required.

Parameters

Name	Type	Description
gtmhub-accountId *	string	Specifies the ID of the gtmhub account. expected in header, sample value: `5be26318e5274a0007f17f61`
parameterId *	string	Specifies the unique identifier (id) of the dashboard parameter. 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/parameters/{parameterId}' \
   -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/parameters/{parameterId}",
 "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/parameters/{parameterId}"



requests.delete(url, headers = headers)

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