Reference

Jump to Get WorkspacesGet Workspaces

Returns the workspaces available to the authenticated user. Call it first: the id of each returned workspace is the workspace_id required by all AIO endpoints, starting with Get AIO Projects.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces

Query parameters

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 1000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

Workspace ID (UUID). Use it as workspace_id in the AIO endpoints.

Value/Type: string

title

Workspace title.

Value/Type: string

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces?direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "id": "7d2e9f41-3a6b-4c85-8e10-2b9f6d4a7c53",
          "title": "Marketing team"
      },
      {
          "id": "c15a8b3e-9d27-4f60-a4e2-6f8d1c0b9e72",
          "title": "Agency clients"
      }
  ]
}

Response example

CSV

id;title
7d2e9f41-3a6b-4c85-8e10-2b9f6d4a7c53;Marketing team
c15a8b3e-9d27-4f60-a4e2-6f8d1c0b9e72;Agency clients

Jump to Get AIO ProjectsGet AIO Projects

Returns the AIO projects in a workspace. The id of each returned project is the project_id required by all other AIO endpoints.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

Query parameters

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

Project ID (UUID). Use it as project_id in the other AIO endpoints.

Value/Type: string

name

Project name.

Value/Type: string

country

Project country (ISO 3166-1 alpha-2 code).

Example: US

Value/Type: string

language

Project language. Possible values: fr, es, de, en, sv, nl, af, it, id, no, da, fi, vi, pl, tr, ms, he, th, ar, hi, ja, pt, ko, zh-Hans, zh-Hant, kk, az, hy, ka, ku, el, cs, bg, sk, ro, hu, ru, fil.

Value/Type: string

aio_data_ready

Whether at least one AIO pipeline run has completed for the project. If false, the data endpoints return no data yet.

Value/Type: boolean

ai_platforms

AI platforms tracked in the project. Use these values as ai_platform in the other AIO endpoints. In CSV responses, the values are separated by commas. Possible values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string[]

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects?direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "id": "3f6c2a1e-8b4d-4e7a-9c21-5d0f7b8e6a14",
          "name": "Brand visibility US",
          "country": "US",
          "language": "en",
          "aio_data_ready": true,
          "ai_platforms": ["CHATGPT", "GOOGLE_AI_OVERVIEW", "PERPLEXITY"]
      },
      {
          "id": "a92d7e05-1c3b-4f68-b0e4-7e2c9d5a8f31",
          "name": "Brand visibility DE",
          "country": "DE",
          "language": "de",
          "aio_data_ready": false,
          "ai_platforms": ["GEMINI", "MICROSOFT_COPILOT"]
      }
  ]
}

Response example

CSV

id;name;country;language;aio_data_ready;ai_platforms
3f6c2a1e-8b4d-4e7a-9c21-5d0f7b8e6a14;Brand visibility US;US;en;true;CHATGPT,GOOGLE_AI_OVERVIEW,PERPLEXITY
a92d7e05-1c3b-4f68-b0e4-7e2c9d5a8f31;Brand visibility DE;DE;de;false;GEMINI,MICROSOFT_COPILOT

Jump to Get AIO ProjectGet AIO Project

Returns a single AIO project. Poll this endpoint to check aio_data_ready before you request project data from the other endpoints.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

Project ID (UUID). Use it as project_id in the other endpoints.

Value/Type: string

name

Project name.

Value/Type: string

country

Project country (ISO 3166-1 alpha-2 code).

Example: US

Value/Type: string

language

Value/Type: string

aio_data_ready

Whether at least one AIO pipeline run has completed for the project. If false, the data endpoints don’t return any data yet.

Value/Type: boolean

ai_platforms

AI platforms tracked in the project. Use these values as ai_platform in the other endpoints. In CSV responses, the values are comma-separated. Possible values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string[]

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id?format=json"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": {
      "id": "3f2b8c1e-7a4d-4e9b-9c61-2d5f0a8e4b17",
      "name": "Example Brand US",
      "country": "US",
      "language": "en",
      "aio_data_ready": true,
      "ai_platforms": [
          "CHATGPT",
          "GOOGLE_AI_OVERVIEW",
          "PERPLEXITY"
      ]
  }
}

Response example

CSV

id;name;country;language;aio_data_ready;ai_platforms
3f2b8c1e-7a4d-4e9b-9c61-2d5f0a8e4b17;Example Brand US;US;en;true;CHATGPT,GOOGLE_AI_OVERVIEW,PERPLEXITY

Jump to Get Tracking DatesGet Tracking Dates

Returns the dates for which the project has data. Use them to choose date_from and date_to values for the other prompt tracking endpoints. The list of dates can have gaps.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/tracking-dates

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

ai_platform

AI platform to return dates for. If omitted, the response includes dates with at least one successful run on any tracked platform. Supported values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

date

Date with at least one successful AIO pipeline run (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2026-10-01

Value/Type: string

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/tracking-dates?ai_platform=CHATGPT&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "date": "2026-10-03"
      },
      {
          "date": "2026-10-02"
      },
      {
          "date": "2026-09-30"
      }
  ]
}

Response example

CSV

date
2026-10-03
2026-10-02
2026-09-30

Jump to Get PromptsGet Prompts

Returns the prompts tracked in an AIO project, with their tags and topic. The endpoint takes no date range: it reflects the current tracking setup, not history.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/prompts

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

ai_platform

AI platform to return prompts for. If omitted, results cover all tracked platforms. Supported values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags, topic.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

prompt

Prompt text.

Value/Type: string

ai_platform

AI platform the prompt is tracked on. Possible values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string

tags

Prompt tags as configured in the project. In CSV responses, tags are returned as a comma-separated list.

Value/Type: string[]

topic

Topic the prompt belongs to.

Value/Type: string

primary_intent

Primary intent of the prompt. Possible values: INFORMATIONAL, NAVIGATIONAL, TRANSACTIONAL, COMMERCIAL.

Value/Type: string

secondary_intent

Secondary intent of the prompt. Possible values: INFORMATIONAL, NAVIGATIONAL, TRANSACTIONAL, COMMERCIAL.

Value/Type: string

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/prompts?ai_platform=CHATGPT&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "prompt": "best project management software for small teams",
          "ai_platform": "CHATGPT",
          "tags": ["software", "comparison"],
          "topic": "Project management tools",
          "primary_intent": "COMMERCIAL",
          "secondary_intent": "INFORMATIONAL"
      },
      {
          "prompt": "how to track team tasks in one place",
          "ai_platform": "CHATGPT",
          "tags": ["how-to"],
          "topic": "Task tracking",
          "primary_intent": "INFORMATIONAL",
          "secondary_intent": "COMMERCIAL"
      }
  ]
}

Response example

CSV

prompt;ai_platform;tags;topic;primary_intent;secondary_intent
best project management software for small teams;CHATGPT;software,comparison;Project management tools;COMMERCIAL;INFORMATIONAL
how to track team tasks in one place;CHATGPT;how-to;Task tracking;INFORMATIONAL;COMMERCIAL

Jump to Get TopicsGet Topics

Returns the topics that the tracked prompts belong to, with topic volume and, optionally, brand visibility per topic.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/topics

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

brand

Name of the brand to measure, as returned by the Get Brands endpoint. The topic_visibility field is returned only when this parameter is passed.

Example: Semrush

Value/Type: string

ai_platform

AI platform to return results for. If omitted, results cover all tracked platforms. Supported values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags, topic.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

topic_id

Topic ID.

Value/Type: string

topic

Topic name.

Example: seo tools

Value/Type: string

topic_volume

Topic volume, as provided. One value per topic.

Value/Type: integer

topic_prompt_count

Number of distinct prompts in the topic.

Value/Type: integer

primary_intent

Primary intent of the topic. Possible values: INFORMATIONAL, NAVIGATIONAL, TRANSACTIONAL, COMMERCIAL.

Value/Type: string

topic_visibility

Brand visibility across the prompts in the topic. Returned only when the brand parameter is passed.

Value/Type: number

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/topics?date_from=2024-01-01&date_to=2024-12-01&brand=Semrush&ai_platform=CHATGPT&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "topic_id": "8c1f2e4a9b7d4f6e",
          "topic": "seo tools",
          "topic_volume": 12400,
          "topic_prompt_count": 18,
          "primary_intent": "COMMERCIAL",
          "topic_visibility": 42.5
      },
      {
          "topic_id": "3a9d5b7c1e2f4a8b",
          "topic": "keyword research",
          "topic_volume": 8100,
          "topic_prompt_count": 11,
          "primary_intent": "INFORMATIONAL",
          "topic_visibility": 27.3
      }
  ]
}

Response example

CSV

topic_id;topic;topic_volume;topic_prompt_count;primary_intent;topic_visibility
8c1f2e4a9b7d4f6e;seo tools;12400;18;COMMERCIAL;42.5
3a9d5b7c1e2f4a8b;keyword research;8100;11;INFORMATIONAL;27.3

Jump to Get BrandsGet Brands

Lists the brands in a project: your own brand (MAIN), tracked competitors (BENCHMARK), and other brands (OTHER).

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/brands

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

brand_type

Type of brands to return. If omitted, brands of all types are returned. Supported values: MAIN, BENCHMARK, OTHER.

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

brand

Brand name.

Value/Type: string

brand_type

Brand type. Possible values: MAIN (your own brand), BENCHMARK (a tracked competitor), OTHER (any other brand).

Value/Type: string

domain

Domain of the brand.

Value/Type: string

primary_url

Primary URL of the brand.

Value/Type: string

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/brands?brand_type=BENCHMARK&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "brand": "Competitor One",
          "primary_url": "https://competitor-one.com/",
          "domain": "competitor-one.com",
          "brand_type": "BENCHMARK"
      },
      {
          "brand": "Competitor Two",
          "primary_url": "https://competitor-two.com/",
          "domain": "competitor-two.com",
          "brand_type": "BENCHMARK"
      }
  ]
}

Response example

CSV

brand;primary_url;domain;brand_type
Competitor One;https://competitor-one.com/;competitor-one.com;BENCHMARK
Competitor Two;https://competitor-two.com/;competitor-two.com;BENCHMARK

Jump to Get CompetitorsGet Competitors

Returns the same metrics as the brand endpoints for every competitor brand (brand type BENCHMARK or OTHER) in a single call. Metrics use the same definitions as the Get Brand Mentions and Get Brand Visibility endpoints.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/competitors

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

ai_platform

Value/Type: string

brand_type

Competitor type: BENCHMARK or OTHER. If omitted, both types are returned. Supported values: MAIN, BENCHMARK, OTHER.

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags, avg_position.

Example: avg_position > 2

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

brand

Competitor brand name.

Value/Type: string

ai_platform

AI platform that generated the response. Possible values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Value/Type: string

visibility

Share of responses that mention the brand: mention_count divided by the total number of responses.

Value/Type: number

mention_count

Number of responses in which the brand was mentioned.

Value/Type: integer

avg_position

Average position of the brand in responses.

Value/Type: number

share_of_voice

Share of voice: total position score divided by total volume, weighted by topic volume.

Value/Type: number

brand_type

Competitor type. Possible values: MAIN, BENCHMARK, OTHER.

Value/Type: string

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/competitors?date_from=2024-01-01&date_to=2024-12-01&ai_platform=CHATGPT&brand_type=BENCHMARK&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "brand": "Competitor One",
          "ai_platform": "CHATGPT",
          "date": "2024-12-01",
          "visibility": 0.42,
          "mention_count": 84,
          "avg_position": 2.3,
          "share_of_voice": 0.27,
          "brand_type": "BENCHMARK"
      },
      {
          "brand": "Competitor Two",
          "ai_platform": "CHATGPT",
          "date": "2024-12-01",
          "visibility": 0.31,
          "mention_count": 62,
          "avg_position": 3.1,
          "share_of_voice": 0.18,
          "brand_type": "BENCHMARK"
      },
      {
          "brand": "Competitor Three",
          "ai_platform": "CHATGPT",
          "date": "2024-12-01",
          "visibility": 0.15,
          "mention_count": 30,
          "avg_position": 4.6,
          "share_of_voice": 0.08,
          "brand_type": "BENCHMARK"
      }
  ]
}

Response example

CSV

brand;ai_platform;date;visibility;mention_count;avg_position;share_of_voice;brand_type
Competitor One;CHATGPT;2024-12-01;0.42;84;2.3;0.27;BENCHMARK
Competitor Two;CHATGPT;2024-12-01;0.31;62;3.1;0.18;BENCHMARK
Competitor Three;CHATGPT;2024-12-01;0.15;30;4.6;0.08;BENCHMARK

Jump to Get Brand VisibilityGet Brand Visibility

Returns brand visibility over time. The numerator (mention_count) and denominator (total_response_count) are returned alongside the ratio (visibility), so you can re-aggregate across platforms without double counting.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/visibility

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

brandRequired

Name of the brand to measure, as returned by the Get Brands endpoint. An unknown brand returns an empty result rather than an error.

Example: Acme

Value/Type: string

ai_platform

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-06-01

Value/Type: string

ai_platform

AI platform that generated the responses. Possible values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string

visibility

Brand visibility: mention_count divided by total_response_count.

Value/Type: number

mention_count

Number of responses that mention the brand.

Value/Type: integer

total_response_count

Total number of responses for tracked prompts, across all brands.

Value/Type: integer

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/visibility?date_from=2024-01-01&date_to=2024-12-01&brand=Acme&ai_platform=CHATGPT&limit=12"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "date": "2024-10-01",
          "ai_platform": "CHATGPT",
          "visibility": 0.42,
          "mention_count": 84,
          "total_response_count": 200
      },
      {
          "date": "2024-11-01",
          "ai_platform": "CHATGPT",
          "visibility": 0.45,
          "mention_count": 90,
          "total_response_count": 200
      },
      {
          "date": "2024-12-01",
          "ai_platform": "CHATGPT",
          "visibility": 0.39,
          "mention_count": 78,
          "total_response_count": 200
      }
  ]
}

Response example

CSV

date;ai_platform;visibility;mention_count;total_response_count
2024-10-01;CHATGPT;0.42;84;200
2024-11-01;CHATGPT;0.45;90;200
2024-12-01;CHATGPT;0.39;78;200

Jump to Get Brand MentionsGet Brand Mentions

Returns brand mentions per prompt for the selected date range.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/mentions

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

brandRequired

Name of the brand to measure, as returned by the Get Brands endpoint. An unknown brand returns an empty result rather than an error.

Example: Acme

Value/Type: string

ai_platform

Value/Type: string

prompt

Prompt text to filter results by. Pass the prompt text itself, not an internal ID.

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags, topic, avg_position, mention_count.

Example: mention_count > 10

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

prompt

Prompt text.

Example: best project management software

Value/Type: string

ai_platform

Value/Type: string

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-06-15

Value/Type: string

tags

Prompt tags, as configured in the project. In CSV output, tags are returned as a comma-separated list.

Value/Type: string[]

topic

Topic the prompt belongs to.

Value/Type: string

product_name

Product name.

Value/Type: string

category

Product category.

Value/Type: string

mention_count

Number of responses in which the brand was mentioned.

Value/Type: integer

avg_position

Average position (avg(position)).

Value/Type: number

share_of_voice

Share of voice: total_position_score / total_volume, weighted by topic volume.

Value/Type: number

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/mentions?date_from=2024-01-01&date_to=2024-12-01&brand=Acme&ai_platform=CHATGPT&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "prompt": "best project management software",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "tags": ["software", "comparison"],
          "topic": "Project management",
          "product_name": "Acme Projects",
          "category": "Productivity software",
          "mention_count": 42,
          "avg_position": 1.8,
          "share_of_voice": 0.37
      },
      {
          "prompt": "project management tools for small teams",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "tags": ["software", "small business"],
          "topic": "Project management",
          "product_name": "Acme Projects",
          "category": "Productivity software",
          "mention_count": 27,
          "avg_position": 2.4,
          "share_of_voice": 0.22
      },
      {
          "prompt": "how to track team tasks",
          "ai_platform": "CHATGPT",
          "date": "2024-06-16",
          "tags": ["how-to"],
          "topic": "Task tracking",
          "product_name": "Acme Tasks",
          "category": "Productivity software",
          "mention_count": 9,
          "avg_position": 3.1,
          "share_of_voice": 0.08
      }
  ]
}

Response example

CSV

prompt;ai_platform;date;tags;topic;product_name;category;mention_count;avg_position;share_of_voice
best project management software;CHATGPT;2024-06-15;software,comparison;Project management;Acme Projects;Productivity software;42;1.8;0.37
project management tools for small teams;CHATGPT;2024-06-15;software,small business;Project management;Acme Projects;Productivity software;27;2.4;0.22
how to track team tasks;CHATGPT;2024-06-16;how-to;Task tracking;Acme Tasks;Productivity software;9;3.1;0.08

Jump to Get Brand SentimentGet Brand Sentiment

Returns how the brand is described in AI responses where it’s mentioned: counts of positive, neutral, and negative sentiment per prompt, AI platform, and date.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/sentiment

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

brandRequired

Name of the brand to measure, as returned by the Get Brands endpoint. An unknown brand returns an empty result rather than an error.

Example: Acme

Value/Type: string

ai_platform

Value/Type: string

prompt

Limits results to a specific prompt. Pass the prompt text, not an internal ID.

Example: best project management software

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

prompt

Prompt text.

Value/Type: string

ai_platform

Value/Type: string

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-06-15

Value/Type: string

product_name

Product name.

Value/Type: string

sentiment_positive_count

Number of positive sentiment values.

Value/Type: integer

sentiment_neutral_count

Number of neutral sentiment values.

Value/Type: integer

sentiment_negative_count

Number of negative sentiment values.

Value/Type: integer

sentiment_positive_rate

Share of positive sentiment values, as a percentage from 0 to 100.

Value/Type: number

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/sentiment?date_from=2024-01-01&date_to=2024-12-01&brand=Acme&ai_platform=CHATGPT&prompt=best%20project%20management%20software&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true,
      "total_count": 2
  },
  "data": [
      {
          "prompt": "best project management software",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "product_name": "Acme Projects",
          "sentiment_positive_count": 14,
          "sentiment_neutral_count": 5,
          "sentiment_negative_count": 1,
          "sentiment_positive_rate": 70.0
      },
      {
          "prompt": "best project management software",
          "ai_platform": "CHATGPT",
          "date": "2024-07-15",
          "product_name": "Acme Projects",
          "sentiment_positive_count": 9,
          "sentiment_neutral_count": 6,
          "sentiment_negative_count": 1,
          "sentiment_positive_rate": 56.25
      }
  ]
}

Response example

CSV

prompt;ai_platform;date;product_name;sentiment_positive_count;sentiment_neutral_count;sentiment_negative_count;sentiment_positive_rate
best project management software;CHATGPT;2024-06-15;Acme Projects;14;5;1;70.0
best project management software;CHATGPT;2024-07-15;Acme Projects;9;6;1;56.25

Jump to Get Brand CitationsGet Brand Citations

Returns citations of the brand’s own domains in AI platform responses, broken down by prompt, for the selected date range. Results are scoped to a single brand.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/citations

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

brandRequired

Name of the brand to measure, as returned by the Get Brands endpoint. An unknown brand returns an empty result rather than an error.

Example: Acme

Value/Type: string

ai_platform

Value/Type: string

prompt

Limits results to a single prompt, identified by its text (not by an internal ID).

Example: best project management software

Value/Type: string

domain_type

Type of the cited domain’s owner, with the same values as brand_type in Get Brands. If omitted, all types are returned. Supported values: MAIN, BENCHMARK, OTHER.

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

prompt

Prompt text.

Value/Type: string

ai_platform

Value/Type: string

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-06-15

Value/Type: string

domain

Cited domain.

Example: acme.com

Value/Type: string

subdomain

Cited subdomain.

Example: blog.acme.com

Value/Type: string

url

Cited URL.

Example: https://blog.acme.com/project-management-guide

Value/Type: string

title

Title of the cited page.

Value/Type: string

domain_type

Type of the cited domain’s owner: MAIN is the project’s own brand and its aliases, BENCHMARK is a tracked competitor, and OTHER is everything else. Possible values: MAIN, BENCHMARK, OTHER.

Value/Type: string

citation_count

Number of citations of the brand’s own domains.

Value/Type: integer

cited_url_count

Number of distinct cited URLs.

Value/Type: integer

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/citations?date_from=2024-01-01&date_to=2024-12-01&brand=Acme&ai_platform=CHATGPT&domain_type=MAIN&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "prompt": "best project management software",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "domain": "acme.com",
          "subdomain": "www.acme.com",
          "url": "https://www.acme.com/features",
          "title": "Acme Features: Plan, Track, and Deliver Projects",
          "domain_type": "MAIN",
          "citation_count": 18,
          "cited_url_count": 4
      },
      {
          "prompt": "best project management software",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "domain": "acme.com",
          "subdomain": "blog.acme.com",
          "url": "https://blog.acme.com/project-management-guide",
          "title": "The Complete Guide to Project Management",
          "domain_type": "MAIN",
          "citation_count": 7,
          "cited_url_count": 2
      },
      {
          "prompt": "project management tools for small teams",
          "ai_platform": "CHATGPT",
          "date": "2024-06-16",
          "domain": "acme.com",
          "subdomain": "www.acme.com",
          "url": "https://www.acme.com/pricing",
          "title": "Acme Pricing Plans",
          "domain_type": "MAIN",
          "citation_count": 5,
          "cited_url_count": 1
      }
  ]
}

Response example

CSV

prompt;ai_platform;date;domain;subdomain;url;title;domain_type;citation_count;cited_url_count
best project management software;CHATGPT;2024-06-15;acme.com;www.acme.com;https://www.acme.com/features;Acme Features: Plan, Track, and Deliver Projects;MAIN;18;4
best project management software;CHATGPT;2024-06-15;acme.com;blog.acme.com;https://blog.acme.com/project-management-guide;The Complete Guide to Project Management;MAIN;7;2
project management tools for small teams;CHATGPT;2024-06-16;acme.com;www.acme.com;https://www.acme.com/pricing;Acme Pricing Plans;MAIN;5;1

Jump to Get SourcesGet Sources

Lists all domains cited in AI responses across tracked prompts, not only brand-owned domains. Unlike Get Brand Citations, results aren’t scoped to a brand.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/sources

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

ai_platform

Value/Type: string

prompt

Limits results to a single tracked prompt, matched by the prompt text (not by an internal ID).

Example: best running shoes for beginners

Value/Type: string

domain_type

Type of the cited domain’s owner. If omitted, all types are returned. Supported values: MAIN, BENCHMARK, OTHER.

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

ai_platform

Value/Type: string

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-06-15

Value/Type: string

domain

Cited domain.

Example: runnersworld.com

Value/Type: string

domain_type

Value/Type: string

source_citation_count

The number of times the domain was cited. Counts citations of all domains, not only brand-owned ones.

Value/Type: integer

source_response_count

The number of responses that cite the domain.

Value/Type: integer

subdomain

Cited subdomain.

Example: www.runnersworld.com

Value/Type: string

title

Title of the cited page.

Value/Type: string

url

Cited URL.

Example: https://www.runnersworld.com/gear/a20865766/best-running-shoes/

Value/Type: string

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/sources?date_from=2024-01-01&date_to=2024-12-01&ai_platform=CHATGPT&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "domain": "runnersworld.com",
          "subdomain": "www.runnersworld.com",
          "url": "https://www.runnersworld.com/gear/a20865766/best-running-shoes/",
          "title": "The Best Running Shoes of 2024",
          "domain_type": "OTHER",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "source_citation_count": 128,
          "source_response_count": 47
      },
      {
          "domain": "example.com",
          "subdomain": "www.example.com",
          "url": "https://www.example.com/running-shoes",
          "title": "Running Shoes for Beginners",
          "domain_type": "MAIN",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "source_citation_count": 64,
          "source_response_count": 31
      },
      {
          "domain": "competitor.com",
          "subdomain": "shop.competitor.com",
          "url": "https://shop.competitor.com/shoes/running",
          "title": "Men's and Women's Running Shoes",
          "domain_type": "BENCHMARK",
          "ai_platform": "CHATGPT",
          "date": "2024-06-15",
          "source_citation_count": 39,
          "source_response_count": 22
      }
  ]
}

Response example

CSV

domain;subdomain;url;title;domain_type;ai_platform;date;source_citation_count;source_response_count
runnersworld.com;www.runnersworld.com;https://www.runnersworld.com/gear/a20865766/best-running-shoes/;The Best Running Shoes of 2024;OTHER;CHATGPT;2024-06-15;128;47
example.com;www.example.com;https://www.example.com/running-shoes;Running Shoes for Beginners;MAIN;CHATGPT;2024-06-15;64;31
competitor.com;shop.competitor.com;https://shop.competitor.com/shoes/running;Men's and Women's Running Shoes;BENCHMARK;CHATGPT;2024-06-15;39;22

Jump to Get Source VisibilityGet Source Visibility

Returns citation coverage over time for the specified brand.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/source-visibility

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

brandRequired

Name of the brand to measure, as returned by the Get Brands endpoint. An unknown brand returns an empty result rather than an error.

Value/Type: string

ai_platform

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 100. Minimum: 1. Maximum: 10000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

ai_platform

Value/Type: string

source_visibility

Share of responses that contain at least one brand-owned citation, calculated as responses_with_citation_count divided by total_response_count.

Value/Type: number

responses_with_citation_count

The number of responses that contain at least one brand-owned citation.

Value/Type: integer

total_response_count

The total number of responses for tracked prompts, across all brands.

Value/Type: integer

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/source-visibility?date_from=2024-01-01&date_to=2024-12-01&brand=Acme&ai_platform=CHATGPT"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "date": "2024-01-01",
          "ai_platform": "CHATGPT",
          "source_visibility": 0.3,
          "responses_with_citation_count": 12,
          "total_response_count": 40
      },
      {
          "date": "2024-01-02",
          "ai_platform": "CHATGPT",
          "source_visibility": 0.35,
          "responses_with_citation_count": 14,
          "total_response_count": 40
      },
      {
          "date": "2024-01-03",
          "ai_platform": "CHATGPT",
          "source_visibility": 0.25,
          "responses_with_citation_count": 10,
          "total_response_count": 40
      }
  ]
}

Response example

CSV

date;ai_platform;source_visibility;responses_with_citation_count;total_response_count
2024-01-01;CHATGPT;0.3;12;40
2024-01-02;CHATGPT;0.35;14;40
2024-01-03;CHATGPT;0.25;10;40

Jump to Get Raw ResponsesGet Raw Responses

Returns the full text of AI platform responses to the project’s tracked prompts for the selected date range.

Jump to EndpointEndpoint

GEThttps://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/responses

Path parameters

workspace_idRequired

Workspace ID (UUID), as returned by the Get Workspaces endpoint. An unknown workspace_id returns a 404 error.

Value/Type: string

project_idRequired

AIO tracking project ID (UUID), as returned by the Get AIO Projects endpoint. The project must belong to the specified workspace; otherwise, the request returns a 404 error.

Value/Type: string

Query parameters

date_fromRequired

Start date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-01-01

Value/Type: string

date_toRequired

End date of the reporting period (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-12-01

Value/Type: string

ai_platform

AI platform to return responses for. If omitted, results cover all tracked platforms. Supported values: CHATGPT, CHATGPT_PAID, CHATGPT_NO_SEARCH, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, MICROSOFT_COPILOT, CLAUDE, GROK, DEEPSEEK, PERPLEXITY, NAVER, OPENEVIDENCE, BAIDU_AI_OVERVIEW, CLAUDE_SEARCH.

Value/Type: string

prompt

Limits results to a single prompt, matched by its prompt text (not an internal ID).

Example: best project management software

Value/Type: string

fields

Response fields to return. If omitted, all fields are returned.

Value/Type: string[]

order_by

Field to sort the results by.

Value/Type: string

direction

Sort direction. Supported values: ASC, DESC.

Value/Type: string

limit

Number of results to return. Default: 10. Minimum: 1. Maximum: 1000.

Value/Type: integer

offset

Number of results to skip. The sum of offset and limit must not exceed 50000.

Value/Type: integer

filter

Filter expression. For the syntax, refer to Filtering. Filterable fields: tags.

Value/Type: string

format

Response format. Supported values: json, csv. Default: json.

Value/Type: string

Response Parameters

meta

Response metadata.

Value/Type: object

Show child parameters

ai_platform

Value/Type: string

date

Response date (ISO 8601 date, formatted as YYYY-MM-DD).

Example: 2024-06-15

Value/Type: string

model_version

Version of the AI model that generated the response.

Value/Type: string

prompt

Prompt text.

Value/Type: string

response_text

Full text of the AI platform’s response.

Value/Type: string

tags

Prompt tags as configured in the project. In CSV output, tags are returned as a comma-separated list.

Value/Type: string[]

Request example

curl -H 'Authorization: Apikey YOUR_API_KEY' "https://api.semrush.com/apis/v4/enterprise/v1/workspaces/:workspace_id/aio/projects/:project_id/prompt-tracking/responses?date_from=2024-01-01&date_to=2024-12-01&ai_platform=CHATGPT&direction=DESC&limit=10"

Response example

JSON

{
  "meta": {
      "request_id": "4fb1773ec2a8d61a0407f464599f897c",
      "status_code": 200,
      "success": true
  },
  "data": [
      {
          "prompt": "best project management software",
          "date": "2024-06-15",
          "ai_platform": "CHATGPT",
          "model_version": "gpt-4o",
          "tags": ["software", "comparison"],
          "response_text": "Popular project management tools include Asana, Trello, and Monday.com..."
      },
      {
          "prompt": "how to manage remote teams",
          "date": "2024-06-15",
          "ai_platform": "CHATGPT",
          "model_version": "gpt-4o",
          "tags": ["remote work"],
          "response_text": "Managing remote teams effectively starts with clear communication..."
      }
  ]
}

Response example

CSV

prompt;date;ai_platform;model_version;tags;response_text
best project management software;2024-06-15;CHATGPT;gpt-4o;software,comparison;Popular project management tools include Asana, Trello, and Monday.com...
how to manage remote teams;2024-06-15;CHATGPT;gpt-4o;remote work;Managing remote teams effectively starts with clear communication...

Last updated: November 4, 2026

Reference

Jump to Get WorkspacesGet Workspaces

Jump to EndpointEndpoint

Query parameters

Response Parameters

Jump to Get AIO ProjectsGet AIO Projects

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get AIO ProjectGet AIO Project

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get Tracking DatesGet Tracking Dates

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get PromptsGet Prompts

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get TopicsGet Topics

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get BrandsGet Brands

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get CompetitorsGet Competitors

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get Brand VisibilityGet Brand Visibility

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get Brand MentionsGet Brand Mentions

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get Brand SentimentGet Brand Sentiment

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get Brand CitationsGet Brand Citations

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get SourcesGet Sources

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get Source VisibilityGet Source Visibility

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Jump to Get Raw ResponsesGet Raw Responses

Jump to EndpointEndpoint

Path parameters

Query parameters

Response Parameters

Was this page helpful?