List tracked URLs ranked by citation count - The Prompting Company

List tracked URLs ranked by citation count

curl --request GET \
  --url https://app.promptingco.com/api/v1/tracked-urls/analytics \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.promptingco.com/api/v1/tracked-urls/analytics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

GET

/

api

/

v1

/

tracked-urls

/

analytics

List tracked URLs ranked by citation count

curl --request GET \
  --url https://app.promptingco.com/api/v1/tracked-urls/analytics \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.promptingco.com/api/v1/tracked-urls/analytics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "ok": false,
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

Authorizations

x-api-key

string

header

required

Organization-scoped API key. Available scopes:

content:read: Read site pages, markdown content, and llms.txt files
content:write: Create, update, and delete site pages and content
prompts:read: Read prompts, topics, and prompt analysis results
prompts:write: Create, update, archive prompts
simulations:read: Read agent-simulation tasks, runs, environments, and analytics
simulations:write: Create and trigger simulation runs
logs:read: Read AI-traffic logs and request-level audit events
analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
analytics:write: Write events to analytics
products:read: Read product metadata and competitor data
products:write: Update product settings and competitor lists

Query Parameters

brandId

string

required

Minimum string length: 1

domain

string

category

string

contentType

string

searchTerm

string

viewId

string

topicId

string

startDate

string

endDate

string

sortBy

enum<string>

Available options:

citation_count,

unique_conversations,

created_at

sortOrder

enum<string>

Available options:

asc,

desc

page

integer

Required range: x >= 1

pageSize

integer

Required range: x >= 1

Response

Successful response

ok

enum<boolean>

required

Available options:

true

data

any