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

descriptionstring · nullableOptional

urlstringRequired

statusstringRequired

mtd_resolutionsinteger · nullableOptional

created_atstringRequired

created_bystringRequired

updated_atstringRequired

updated_bystringRequired

monthly_budgetinteger · nullableRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

last_tracked_activitystring · nullableRead-onlyRequired

get/tags

GET /tags HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": "text",
    "tag_id": "text",
    "name": "text",
    "description": "text",
    "url": "text",
    "status": "text",
    "mtd_resolutions": 1,
    "created_at": "text",
    "created_by": "text",
    "updated_at": "text",
    "updated_by": "text",
    "monthly_budget": 1,
    "last_tracked_activity": "text"
  }
]

Create Tag

post

Creates a new tracking tag for your workspace.

Authorizations

AuthorizationstringRequired

Bearer token for authentication

Body

aliasstringRequired

namestring · nullableOptional

descriptionstring · nullableOptional

Responses

200

Successful Response

application/json

idstringRequired

tag_idstringRequired

namestringRequired

descriptionstring · nullableOptional

urlstringRequired

statusstringRequired

mtd_resolutionsinteger · nullableOptional

created_atstringRequired

created_bystringRequired

updated_atstringRequired

updated_bystringRequired

monthly_budgetinteger · nullableRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

last_tracked_activitystring · nullableRead-onlyRequired

422

Validation Error

application/json

post/tags

POST /tags HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "alias": "text",
  "name": "text",
  "description": "text"
}

{
  "id": "text",
  "tag_id": "text",
  "name": "text",
  "description": "text",
  "url": "text",
  "status": "text",
  "mtd_resolutions": 1,
  "created_at": "text",
  "created_by": "text",
  "updated_at": "text",
  "updated_by": "text",
  "monthly_budget": 1,
  "last_tracked_activity": "text"
}

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

descriptionstring · nullableOptional

urlstringRequired

statusstringRequired

mtd_resolutionsinteger · nullableOptional

created_atstringRequired

created_bystringRequired

updated_atstringRequired

updated_bystringRequired

monthly_budgetinteger · nullableRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

last_tracked_activitystring · nullableRead-onlyRequired

422

Validation Error

application/json

get/tags/{id}

GET /tags/{id} HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "tag_id": "text",
  "name": "text",
  "description": "text",
  "url": "text",
  "status": "text",
  "mtd_resolutions": 1,
  "created_at": "text",
  "created_by": "text",
  "updated_at": "text",
  "updated_by": "text",
  "monthly_budget": 1,
  "last_tracked_activity": "text"
}

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

422

Validation Error

application/json

delete/tags/{id}

DELETE /tags/{id} HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "message": "text"
}

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

namestring · nullableOptional

descriptionstring · nullableOptional

tag_capinteger · nullableOptional

statusstring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

idstringRequired

tag_idstringRequired

namestringRequired

descriptionstring · nullableOptional

urlstringRequired

statusstringRequired

mtd_resolutionsinteger · nullableOptional

created_atstringRequired

created_bystringRequired

updated_atstringRequired

updated_bystringRequired

monthly_budgetinteger · nullableRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

last_tracked_activitystring · nullableRead-onlyRequired

422

Validation Error

application/json

patch/tags/{id}

PATCH /tags/{id} HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "name": "text",
  "description": "text",
  "tag_cap": 1,
  "status": "enabled"
}

{
  "id": "text",
  "tag_id": "text",
  "name": "text",
  "description": "text",
  "url": "text",
  "status": "text",
  "mtd_resolutions": 1,
  "created_at": "text",
  "created_by": "text",
  "updated_at": "text",
  "updated_by": "text",
  "monthly_budget": 1,
  "last_tracked_activity": "text"
}

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

descriptionstring · nullableOptional

urlstringRequired

statusstringRequired

mtd_resolutionsinteger · nullableOptional

created_atstringRequired

created_bystringRequired

updated_atstringRequired

updated_bystringRequired

monthly_budgetinteger · nullableRead-onlyRequired

Only surface the budget cap when budgets are actually enabled.

last_tracked_activitystring · nullableRead-onlyRequired

422

Validation Error

application/json

post/tags/{id}/status

POST /tags/{id}/status HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "enabled"
}

{
  "id": "text",
  "tag_id": "text",
  "name": "text",
  "description": "text",
  "url": "text",
  "status": "text",
  "mtd_resolutions": 1,
  "created_at": "text",
  "created_by": "text",
  "updated_at": "text",
  "updated_by": "text",
  "monthly_budget": 1,
  "last_tracked_activity": "text"
}