## 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](https://cite.me.in/docs) for more information.

## Authentication

All endpoints require a Bearer token in the header:

Retrieve your API key from your [profile page](https://cite.me.in/profile).

### GET /api/me

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

#### Response: 200

| Field | Type | Description |
| --- | --- | --- |
|  |  | The email address of the user |
|  |  | The ID of the user |
|  |  | The plan of the user e.g. , , , |
|  |  | The date the site was created e.g. |
|  |  | The domain of the site e.g. |
|  |  | The summary of the site e.g. |

#### Status Codes

| Code | Meaning |
| --- | --- |
| 200 | User details with sites |
| 401 | Unauthorized |
| 404 | User not found |

#### Example

### 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

| Parameter | Type | Description |
| --- | --- | --- |
|  |  | The ID of the user to get details for e.g. |

#### Response: 200

| Field | Type | Description |
| --- | --- | --- |
|  |  | The email address of the user |
|  |  | The ID of the user |
|  |  | The plan of the user e.g. , , , |
|  |  | The date the site was created e.g. |
|  |  | The domain of the site e.g. |
|  |  | The summary of the site e.g. |

#### Status Codes

| Code | Meaning |
| --- | --- |
| 200 | User details with sites |
| 401 | Unauthorized |
| 404 | User not found |

#### Example

### 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

| Parameter | Type | Description |
| --- | --- | --- |
|  |  | The domain of the site to get queries for e.g. |

#### Response: 200

| Field | Type | Description |
| --- | --- | --- |
|  |  | The date the site was created e.g. |
|  |  | The domain of the site e.g. |
|  |  | The summary of the site e.g. |
|  |  | The email address of the user e.g. |
|  |  | The ID of the user |
|  |  | The role of the user on the site e.g. or |

#### Status Codes

| Code | Meaning |
| --- | --- |
| 200 | Site details with users |
| 401 | Unauthorized |
| 404 | Domain not recognised or not found |

#### Example

### 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

| Parameter | Type | Description |
| --- | --- | --- |
|  |  | The domain of the site to get metrics for e.g. |

#### Response: 200

| Field | Type | Description |
| --- | --- | --- |
|  |  | Total citations for the current week |
|  |  | Total citations for the previous week |
|  |  | Percentage of queries where domain appears in citations for the current week (0-100) |
|  |  | Percentage of queries where domain appears in citations for the previous week (0-100) |
|  |  | LLM visibility score for the current week |
|  |  | LLM visibility score for the previous week |
|  |  | Your citations only for the current week |
|  |  | Your citations only for the previous week |

#### Status Codes

| Code | Meaning |
| --- | --- |
| 200 | Queries for the site |
| 401 | Unauthorized |
| 404 | Domain not recognised or not found |

#### Example

### 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

| Parameter | Type | Description |
| --- | --- | --- |
|  |  | The domain of the site to get queries for e.g. |

#### Response: 200

| Field | Type | Description |
| --- | --- | --- |
|  |  | The model used for the queries e.g. |
|  |  | The date these queries were inspected e.g. |
|  |  | The platform used for the queries e.g. |
|  |  | Explanation of the classification |
|  |  | Classification: direct=your domain, indirect=related content, unrelated=not relevant |
|  |  | The citation URL |
|  |  | The group this query belongs to e.g. |
|  |  | The query itself e.g. |
|  |  | The complete response from the LLM to this query |
|  |  | The overall sentiment e.g. , , , |
|  |  | A 2-3 sentence summary of the sentiment of the run e.g. |

#### Status Codes

| Code | Meaning |
| --- | --- |
| 200 | Queries for the site |
| 401 | Unauthorized |
| 404 | Domain not recognised or not found |