Cite.me.inCite.me.in

cite.me.in API

Monitor your brand's visibility in AI-generated responses. Authenticate with your API key from the profile page. See the documentation for more information.

Authentication

All endpoints require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Retrieve your API key from your profile page.

GET /api/me

Responds with the details of the authenticated user. Includes all the sites they have access to.

Response: 200

FieldTypeDescription
emailstringThe email address of the user
idstringThe ID of the user
planstringThe plan of the user e.g. trial, paid, gratis, cancelled
sites[].createdAtstringThe date the site was created e.g. 2024-01-01
sites[].domainstringThe domain of the site e.g. example.com
sites[].summarystringThe summary of the site e.g. This product is fantastic

Status Codes

CodeMeaning
200User details with sites
401Unauthorized
404User not found

Example

const response = await fetch("https://cite.me.in/api/me", {
  headers: { Authorization: "Bearer YOUR_API_KEY" }
});
const data = await response.json();

GET /api/user/{id}

Responds with the details of the given user. Includes all the sites they have access to. You can only use this endpoint with your own user ID.

Path Parameters

ParameterTypeDescription
idstringThe ID of the user to get details for e.g. clxyz123abc

Response: 200

FieldTypeDescription
emailstringThe email address of the user
idstringThe ID of the user
planstringThe plan of the user e.g. trial, paid, gratis, cancelled
sites[].createdAtstringThe date the site was created e.g. 2024-01-01
sites[].domainstringThe domain of the site e.g. example.com
sites[].summarystringThe summary of the site e.g. This product is fantastic

Status Codes

CodeMeaning
200User details with sites
401Unauthorized
404User not found

Example

const response = await fetch("https://cite.me.in/api/user/{id}", {
  headers: { Authorization: "Bearer YOUR_API_KEY" }
});
const data = await response.json();

GET /api/site/{domain}

Responds with the details of the given site. Includes the content of the site, the summary, the date the site was added, and the users who have access to that site and their roles (owner or member).

Path Parameters

ParameterTypeDescription
domainstringThe domain of the site to get queries for e.g. example.com

Response: 200

FieldTypeDescription
createdAtstringThe date the site was created e.g. 2024-01-01
domainstringThe domain of the site e.g. example.com
summarystringThe summary of the site e.g. This product is fantastic
users[].emailstringThe email address of the user e.g. [email protected]
users[].idstringThe ID of the user
users[].rolestringThe role of the user on the site e.g. owner or member

Status Codes

CodeMeaning
200Site details with users
401Unauthorized
404Domain not recognised or not found

Example

const response = await fetch("https://cite.me.in/api/site/example.com", {
  headers: { Authorization: "Bearer YOUR_API_KEY" }
});
const data = await response.json();

GET /api/site/{domain}/metrics

Responds with the metrics for the given site. Overall citations, your citations, visibility score, and query coverage rate. For each metric includes value for the current week and for the previous week.

Path Parameters

ParameterTypeDescription
domainstringThe domain of the site to get metrics for e.g. example.com

Response: 200

FieldTypeDescription
allCitations.currentintegerTotal citations for the current week
allCitations.previousnumberTotal citations for the previous week
queryCoverageRate.currentnumberPercentage of queries where domain appears in citations for the current week (0-100)
queryCoverageRate.previousnumberPercentage of queries where domain appears in citations for the previous week (0-100)
visbilityScore.currentnumberLLM visibility score for the current week
visbilityScore.previousnumberLLM visibility score for the previous week
yourCitations.currentnumberYour citations only for the current week
yourCitations.previousnumberYour citations only for the previous week

Status Codes

CodeMeaning
200Queries for the site
401Unauthorized
404Domain not recognised or not found

Example

const response = await fetch("https://cite.me.in/api/site/example.com/metrics", {
  headers: { Authorization: "Bearer YOUR_API_KEY" }
});
const data = await response.json();

GET /api/site/{domain}/queries

Responds with the queries for the given site. For each platform list all the queries run against that platform, the citations found, and the platform sentiment.

Path Parameters

ParameterTypeDescription
domainstringThe domain of the site to get queries for e.g. example.com

Response: 200

FieldTypeDescription
platforms[].modelstringThe model used for the queries e.g. gpt-5-chat-latest
platforms[].onDatestringThe date these queries were inspected e.g. 2024-01-01
platforms[].platformstringThe platform used for the queries e.g. chatgpt
platforms[].queries[].citations[].reasonstringExplanation of the classification
platforms[].queries[].citations[].relationshipstringClassification: direct=your domain, indirect=related content, unrelated=not relevant
platforms[].queries[].citations[].urlstringThe citation URL
platforms[].queries[].groupstringThe group this query belongs to e.g. 1. discovery
platforms[].queries[].querystringThe query itself e.g. "What are the best retail platforms?"
platforms[].queries[].responsestringThe complete response from the LLM to this query
platforms[].sentiment.labelstringThe overall sentiment e.g. positive, negative, neutral, mixed
platforms[].sentiment.summarystringA 2-3 sentence summary of the sentiment of the run e.g. "Rentail.space is cited positively across multiple queries, frequently appearing as a top recommendation for finding short-term retail space. It ranks prominently in citations and is described as a reliable marketplace for pop-up and kiosk leasing."

Status Codes

CodeMeaning
200Queries for the site
401Unauthorized
404Domain not recognised or not found

Example

const response = await fetch("https://cite.me.in/api/site/example.com/queries", {
  headers: { Authorization: "Bearer YOUR_API_KEY" }
});
const data = await response.json();