Tags endpoints
The Tags endpoints enable you to perform CRUD operations with tags in your Quantive Results account. This group contains endpoints that also enable you to assign a tag to a Quantive Results item.
Returns all tags matching specified parameters.
Supports filtering, sorting and field projection.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
filter | string | Specifies the filter in Mongo syntax.
For example, to get a single tag by their Id, use filter={"_id":"611fce386400780001b19e1e"}.
There is also the option to filter by multiple properties like filter={"$and":[{"itemsTaggedCount":{"$gt":50}},{"isActive":false}] expected in query, sample value: {"_id":"611fce386400780001b19e1e"} |
sort | string | Specifies the sort expression.
For example, to sort tags by their creation date user sort=dateCreated or sort=-dateCreated (to sort in descending order). expected in query, sample value: dateCreated |
fields | string | Specifies the list of fields to be returned in the response.
For example, to get only the tag's id, isActive, title or name expected in query, sample value: name,title,isActive |
skip | string | Specifies how many items to skip from the beginning of the collection.
Use this to implement paging.
For example, if you want to get tags 5-10 use skip=5&take=5.
Always sort your response to ensure that you're paging through the collection in the same order, for example sort=dateCreated&skip=5&take=5. expected in query, sample value: 5 |
take | string | Specifies how many items to take from the collection.
Use this to implement paging.
For example, if you want to get the first 10 tags use take=10.
Always sort your response to ensure that you're paging through the collection in the same order, for example sort=dateCreated&take=10. expected in query, sample value: 10 |
Expected response codes
200 | tagsDetailResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X GET 'https://app.gtmhub.com/api/v2/tags?filter={"_id":"611fce386400780001b19e1e"}&sort=dateCreated&fields=name,title,isActive&skip=5&take=10' \ -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/v2/tags?filter={"_id":"611fce386400780001b19e1e"}&sort=dateCreated&fields=name,title,isActive&skip=5&take=10", "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/v2/tags"
requests.get(url, headers = headers)
{
"tags": [
{
"createdBy": "string",
"dashboardsTaggedCount": 2,
"dateCreated": "string value",
"goalsTaggedCount": 2,
"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"
}
],
"itemsTaggedCount": 2,
"name": "string value",
"title": "string value"
}
],
"totalCount": 2
}
Adds a tag to the specified dashboard. If this it the first usage of the tag, it will be created.
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 | tagResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X POST 'https://app.gtmhub.com/api/v1/dashboards/{dashboardId}/tags' \ -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/dashboards/{dashboardId}/tags", "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.gtmhub.com/api/v1/dashboards/{dashboardId}/tags"
requests.post(url, headers = headers)
{
"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": "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"
}
],
"name": "string value",
"title": "string value"
}
Adds a tag to the specified goal. If this is the first usage of the tag it will be created.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
goalId * | string | Specifies the unique identifier of the goal (objective). expected in path, sample value: 6138969ab6adf10001fc329c |
tag * | object | The object representing a tag by its title.
The tag is identified by the lowercase space trimmed
version of the title. A "tag1" item is the same as "Tag1" and " TAG1". expected in body, sample value: { "title": "annual", "titles": "[annual, finance]" } |
Expected response codes
201 | tagResponse |
304 | string message returned by the service |
curl -X POST 'https://app.gtmhub.com/api/v1/goals/{id}/tags' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"title":"annual","titles":"[annual, finance]"}'
var body ={ "title": "annual", "titles": "[annual, finance]" };
var settings = { "url": "https://app.gtmhub.com/api/v1/goals/{id}/tags", "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.gtmhub.com/api/v1/goals/{id}/tags"
body = { "title": "annual", "titles": "[annual, finance]" };
requests.post(url, data=json.dumps(body), headers = headers)
{
"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": "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"
}
],
"name": "string value",
"title": "string value"
}
Adds a tag to the specified insight. If this is the first usage of the tag it will be created.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
id * | string | Specifies the the insight ID. expected in path, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
201 | tagResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X POST 'https://app.gtmhub.com/api/v1/insights/{id}/tags' \ -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/insights/{id}/tags", "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.gtmhub.com/api/v1/insights/{id}/tags"
requests.post(url, headers = headers)
{
"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": "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"
}
],
"name": "string value",
"title": "string value"
}
Create new tag
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
200 | tagsDetailResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X POST 'https://app.gtmhub.com/api/v1/tags' \ -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/tags", "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.gtmhub.com/api/v1/tags"
requests.post(url, headers = headers)
{
"tags": [
{
"createdBy": "string",
"dashboardsTaggedCount": 2,
"dateCreated": "string value",
"goalsTaggedCount": 2,
"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"
}
],
"itemsTaggedCount": 2,
"name": "string value",
"title": "string value"
}
],
"totalCount": 2
}
Activates tags by tag ids.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
tagIds * | object | An array of tag ids of tags to be activated or deactivated. expected in body, sample value: { "tagIds": [ "string value 1", "string value 2" ] } |
Expected response codes
200 | changeTagStatusResponse |
304 | string message returned by the service |
curl -X POST 'https://app.gtmhub.com/api/v1/tags/activate' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"tagIds":["string value 1","string value 2"]}'
var body ={ "tagIds": [ "string value 1", "string value 2" ] };
var settings = { "url": "https://app.gtmhub.com/api/v1/tags/activate", "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.gtmhub.com/api/v1/tags/activate"
body = { "tagIds": [ "string value 1", "string value 2" ] };
requests.post(url, data=json.dumps(body), headers = headers)
{
"modifiedCount": 2
}
Deactivates tags by tag ids.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
tagIds * | object | An array of tag ids of tags to be activated or deactivated. expected in body, sample value: { "tagIds": [ "string value 1", "string value 2" ] } |
Expected response codes
200 | changeTagStatusResponse |
304 | string message returned by the service |
403 | forbidden |
curl -X POST 'https://app.gtmhub.com/api/v1/tags/deactivate' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"tagIds":["string value 1","string value 2"]}'
var body ={ "tagIds": [ "string value 1", "string value 2" ] };
var settings = { "url": "https://app.gtmhub.com/api/v1/tags/deactivate", "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.gtmhub.com/api/v1/tags/deactivate"
body = { "tagIds": [ "string value 1", "string value 2" ] };
requests.post(url, data=json.dumps(body), headers = headers)
{
"modifiedCount": 2
}
Merge tags by given ids.
If tag with the given name exists will be used, otherwise it will be created.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
Body * | object | An object that contains two value pairs: "mergeFrom" and "mergeInto". expected in body, sample value: { "mergeFrom": [ "611fce386400780001b19e1e", "611kge386300780081b19e1e" ], "mergeInto": "Leadership" } |
Expected response codes
200 | ok |
400 | bad request |
402 | payment required |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X POST 'https://app.gtmhub.com/api/v1/tags/merge' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"mergeFrom":["611fce386400780001b19e1e","611kge386300780081b19e1e"],"mergeInto":"Leadership"}'
var body ={ "mergeFrom": [ "611fce386400780001b19e1e", "611kge386300780081b19e1e" ], "mergeInto": "Leadership" };
var settings = { "url": "https://app.gtmhub.com/api/v1/tags/merge", "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.gtmhub.com/api/v1/tags/merge"
body = { "mergeFrom": [ "611fce386400780001b19e1e", "611kge386300780081b19e1e" ], "mergeInto": "Leadership" };
requests.post(url, data=json.dumps(body), headers = headers)
GenerateGoalTags returns a list of goal tags suggestions.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
suggestions * | object | The object used for auto-tagging generation. expected in body, sample value: { "text": "string value" } |
Expected response codes
200 | tagsConfidenceSuggestion |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X POST 'https://app.gtmhub.com/api/v1/tags/suggestions' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"text":"string value"}'
var body ={ "text": "string value" };
var settings = { "url": "https://app.gtmhub.com/api/v1/tags/suggestions", "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.gtmhub.com/api/v1/tags/suggestions"
body = { "text": "string value" };
requests.post(url, data=json.dumps(body), headers = headers)
{
"suggestions": [
{
"confidence": 2,
"tagTitle": "string value"
}
],
"totalCount": 2
}
Rename given tag by its id.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
tagId * | string | The unique identifier (ID) of the tag that will be renamed. expected in query, sample value: "611fce386400780001b19e1e" |
title * | object | The new title of the tag. expected in body, sample value: { "title": "string value" } |
Expected response codes
204 | no content |
400 | bad request |
402 | payment required |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X PATCH 'https://app.gtmhub.com/api/v1/tags/{tagId}?tagId="611fce386400780001b19e1e"' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"title":"string value"}'
var body ={ "title": "string value" };
var settings = { "url": "https://app.gtmhub.com/api/v1/tags/{tagId}?tagId="611fce386400780001b19e1e"", "method": "PATCH", "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.gtmhub.com/api/v1/tags/{tagId}"
body = { "title": "string value" };
requests.patch(url, data=json.dumps(body), headers = headers)
Removes the tag from the specified dashboard.
The tag will not be deleted even if the specified dashboard is the only item tagged with it.
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 |
404 | not found |
500 | internal server error |
curl -X DELETE 'https://app.gtmhub.com/api/v1/dashboards/{dashboardId}/tags' \ -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/dashboards/{dashboardId}/tags", "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.gtmhub.com/api/v1/dashboards/{dashboardId}/tags"
requests.delete(url, headers = headers)
Removes the tag from the specified goal. The tag will not be deleted even if the specified goal is the only item tagged with it.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
goalId * | string | Specifies the unique identifier of the goal (objective). expected in path, sample value: 6138969ab6adf10001fc329c |
tag * | object | The object representing a tag by its title.
The tag is identified by the lowercase space trimmed
version of the title. A "tag1" item is the same as "Tag1" and " TAG1". expected in body, sample value: { "title": "annual", "titles": "[annual, finance]" } |
Expected response codes
204 | no content |
curl -X DELETE 'https://app.gtmhub.com/api/v1/goals/{id}/tags' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"title":"annual","titles":"[annual, finance]"}'
var body ={ "title": "annual", "titles": "[annual, finance]" };
var settings = { "url": "https://app.gtmhub.com/api/v1/goals/{id}/tags", "method": "DELETE", "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.gtmhub.com/api/v1/goals/{id}/tags"
body = { "title": "annual", "titles": "[annual, finance]" };
requests.delete(url, data=json.dumps(body), headers = headers)
Removes the tag from the specified insight. The tag will not be deleted even if the specified insight is the only item tagged with it.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
id * | string | Specifies the the insight ID. expected in path, sample value: 5be26318e5274a0007f17f61 |
Expected response codes
204 | no content |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
404 | not found |
500 | internal server error |
curl -X DELETE 'https://app.gtmhub.com/api/v1/insights/{id}/tags' \ -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/insights/{id}/tags", "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.gtmhub.com/api/v1/insights/{id}/tags"
requests.delete(url, headers = headers)
Bulk delete of provided tags ids.
Parameters
Name | Type | Description |
---|---|---|
gtmhub-accountId * | string | Specifies the ID of the gtmhub account. expected in header, sample value: 5be26318e5274a0007f17f61 |
tagIds * | object | An array of tag ids of tags to be deleted. expected in body, sample value: { "Body": [ "611fce386400780001b19e1e", "611fce386400781001b18e2f" ] } |
Expected response codes
200 | deleteTagResponse |
400 | bad request |
401 | unauthorized |
402 | payment required |
403 | forbidden |
500 | internal server error |
curl -X DELETE 'https://app.gtmhub.com/api/v1/tags' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {token}' \
-H 'gtmhub-accountId: 5be26318e5274a0007f17f61' \
-d '{"Body":["611fce386400780001b19e1e","611fce386400781001b18e2f"]}'
var body ={ "Body": [ "611fce386400780001b19e1e", "611fce386400781001b18e2f" ] };
var settings = { "url": "https://app.gtmhub.com/api/v1/tags", "method": "DELETE", "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.gtmhub.com/api/v1/tags"
body = { "Body": [ "611fce386400780001b19e1e", "611fce386400781001b18e2f" ] };
requests.delete(url, data=json.dumps(body), headers = headers)
{
"deletedCount": 2
}
Oops! Looks like there are no API calls of that type for this Endpoint