Skip to main content
POST
/
v1
/
reports
/
citations
JavaScript
import Profound from 'profoundai';

const client = new Profound({
  apiKey: process.env['PROFOUND_API_KEY'], // This is the default and can be omitted
});

const response = await client.reports.citations({
  category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  end_date: '2019-12-27T18:11:19.117Z',
  metrics: ['count'],
  start_date: '2019-12-27T18:11:19.117Z',
});

console.log(response.data);
{
  "info": {
    "total_rows": 123,
    "query": {}
  },
  "data": [
    {
      "metrics": [
        123
      ],
      "dimensions": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
metrics
enum<string>[]
required

Metrics to include. share_of_voice is deprecated, use citation_share instead.

Available options:
count,
citation_share,
share_of_voice
​
category_id
string<uuid>
required
​
start_date
string<date-time>
required

Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

​
end_date
string<date-time>
required

End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

​
date_interval
enum<string>
default:day

Date interval for the report. (only used with date dimension)

Available options:
hour,
day,
week,
month,
year,
relative_week
​
dimensions
enum<string>[]

Dimensions to group the report by.

Available options:
hostname,
path,
date,
region,
topic,
topic_id,
model,
tag,
prompt,
prompt_id,
url,
root_domain,
persona,
citation_category
​
order_by
Order By · object
Custom ordering of the report results.

The order is a record of key-value pairs where:
- `key` is the field to order by, which can be a metric and/or `date`, `hostname`, `path` dimensions
- `value` is the direction of the order, either `asc` for ascending or `desc` for descending.

When not specified, the default order is the first metric in the query descending.
Examples:
{ "date": "asc" }

{ "count": "desc", "date": "asc" }
​
pagination
Pagination · object

Pagination settings for the report results.

​
filters
(HostnameFilter · object | PathFilter · object | RegionIdFilter · object | TopicIdFilter · object | TopicNameFilter · object | ModelIdFilter · object | TagIdFilter · object | UrlFilter · object | RootDomainFilter · object | PromptTypeFilter · object | PersonaIdFilter · object | CitationCategoryFilter · object | PromptFilter · object | PromptIdFilter · object)[]

List of filters to apply to the citations report.

Filter by hostname

Response

Successful Response

​
info
Info · object
required

Base model for report information.

​
data
Result · object[]
required