WWatchLLM
get/api/v2/brands

List brands, competitors, ignored brands, and related entities.

List brands, competitors, ignored brands, and related entities.

Requires bearer API key

Parameters

NameInDescription
X-Project-IdheaderRequired for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.string
pagequeryNo description provided.integer
sizequeryNo description provided.integer
queryqueryNo description provided.string
relationqueryNo description provided.string

Responses

200

Successful JSON response.

application/json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "domain": {
            "type": "string",
            "nullable": true
          },
          "relation": {
            "type": "string",
            "enum": [
              "SELF",
              "DIRECT_COMPETITOR",
              "OTHER",
              "IGNORED"
            ]
          },
          "source": {
            "type": "string",
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "relation"
        ]
      }
    },
    "total": {
      "type": "integer"
    },
    "page": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "totalPages": {
      "type": "integer"
    }
  },
  "required": [
    "brands",
    "total",
    "page",
    "size",
    "totalPages"
  ]
}

Try it

Send this request to the local WatchLLM REST handler. Use a key from /workspace/api; organization keys can include X-Project-Id only when the endpoint documents that header.