Tags

List Tags

get

Returns all tracking tags in your workspace.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Responses
200

Successful Response

application/json
idstringRequired
tag_idstringRequired
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
urlstringRequired
statusstringRequired
mtd_resolutionsany ofOptional
integerOptional
or
nullOptional
created_atstringRequired
created_bystringRequired
updated_atstringRequired
updated_bystringRequired
monthly_budgetany ofRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

integerOptional
or
nullOptional
last_tracked_activityany ofRead-onlyRequired
stringOptional
or
nullOptional
get
/tags
200

Successful Response

Create Tag

post

Creates a new tracking tag for your workspace.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Body
aliasstringRequired
nameany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
idstringRequired
tag_idstringRequired
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
urlstringRequired
statusstringRequired
mtd_resolutionsany ofOptional
integerOptional
or
nullOptional
created_atstringRequired
created_bystringRequired
updated_atstringRequired
updated_bystringRequired
monthly_budgetany ofRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

integerOptional
or
nullOptional
last_tracked_activityany ofRead-onlyRequired
stringOptional
or
nullOptional
post
/tags

Get Tag

get

Returns a single tag by ID. Returns 404 if the tag does not exist.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Responses
200

Successful Response

application/json
idstringRequired
tag_idstringRequired
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
urlstringRequired
statusstringRequired
mtd_resolutionsany ofOptional
integerOptional
or
nullOptional
created_atstringRequired
created_bystringRequired
updated_atstringRequired
updated_bystringRequired
monthly_budgetany ofRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

integerOptional
or
nullOptional
last_tracked_activityany ofRead-onlyRequired
stringOptional
or
nullOptional
get
/tags/{id}

Delete Tag

delete

Permanently deletes a tag.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Responses
200

Successful Response

application/json
idstringRequired
namestringRequired
messagestringRequired
delete
/tags/{id}

Update Tag

patch

Updates a tag's name, description, status, or monthly spend cap. Only send the fields you want to change.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Body
nameany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
tag_capany ofOptional
integerOptional
or
nullOptional
statusany ofOptional
string · enumOptionalPossible values:
or
nullOptional
Responses
200

Successful Response

application/json
idstringRequired
tag_idstringRequired
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
urlstringRequired
statusstringRequired
mtd_resolutionsany ofOptional
integerOptional
or
nullOptional
created_atstringRequired
created_bystringRequired
updated_atstringRequired
updated_bystringRequired
monthly_budgetany ofRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

integerOptional
or
nullOptional
last_tracked_activityany ofRead-onlyRequired
stringOptional
or
nullOptional
patch
/tags/{id}

Update Tag Status

post

Enables or disables a tag.

Authorizations
AuthorizationstringRequired

Bearer token for authentication

Path parameters
idstringRequired
Body
statusstring · enumRequiredPossible values:
Responses
200

Successful Response

application/json
idstringRequired
tag_idstringRequired
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
urlstringRequired
statusstringRequired
mtd_resolutionsany ofOptional
integerOptional
or
nullOptional
created_atstringRequired
created_bystringRequired
updated_atstringRequired
updated_bystringRequired
monthly_budgetany ofRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

integerOptional
or
nullOptional
last_tracked_activityany ofRead-onlyRequired
stringOptional
or
nullOptional
post
/tags/{id}/status

Last updated

Was this helpful?