Query Citations

JavaScript

import Profound from '@profoundai/client';

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);

import os
from datetime import datetime
from profound import Profound

client = Profound(
    api_key=os.environ.get("PROFOUND_API_KEY"),  # This is the default and can be omitted
)
response = client.reports.citations(
    category_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    end_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),
    metrics=["count"],
    start_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),
)
print(response.data)

curl --request POST \
  --url https://api.tryprofound.com/v1/reports/citations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metrics": [],
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "date_interval": "day",
  "dimensions": [],
  "order_by": {},
  "pagination": {
    "limit": 10000,
    "offset": 0
  },
  "filters": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v1/reports/citations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'metrics' => [
        
    ],
    'category_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'date_interval' => 'day',
    'dimensions' => [
        
    ],
    'order_by' => [
        
    ],
    'pagination' => [
        'limit' => 10000,
        'offset' => 0
    ],
    'filters' => [
        [
                'field' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tryprofound.com/v1/reports/citations"

	payload := strings.NewReader("{\n  \"metrics\": [],\n  \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {},\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.tryprofound.com/v1/reports/citations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metrics\": [],\n  \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {},\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tryprofound.com/v1/reports/citations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metrics\": [],\n  \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {},\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "info": {
    "total_rows": 123,
    "query": {}
  },
  "data": [
    {
      "metrics": [
        123
      ],
      "dimensions": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

reports

citations

JavaScript

import Profound from '@profoundai/client';

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);

import os
from datetime import datetime
from profound import Profound

client = Profound(
    api_key=os.environ.get("PROFOUND_API_KEY"),  # This is the default and can be omitted
)
response = client.reports.citations(
    category_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    end_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),
    metrics=["count"],
    start_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),
)
print(response.data)

curl --request POST \
  --url https://api.tryprofound.com/v1/reports/citations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metrics": [],
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "date_interval": "day",
  "dimensions": [],
  "order_by": {},
  "pagination": {
    "limit": 10000,
    "offset": 0
  },
  "filters": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v1/reports/citations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'metrics' => [
        
    ],
    'category_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'date_interval' => 'day',
    'dimensions' => [
        
    ],
    'order_by' => [
        
    ],
    'pagination' => [
        'limit' => 10000,
        'offset' => 0
    ],
    'filters' => [
        [
                'field' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tryprofound.com/v1/reports/citations"

	payload := strings.NewReader("{\n  \"metrics\": [],\n  \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {},\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.tryprofound.com/v1/reports/citations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metrics\": [],\n  \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {},\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tryprofound.com/v1/reports/citations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metrics\": [],\n  \"category_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {},\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "info": {
    "total_rows": 123,
    "query": {}
  },
  "data": [
    {
      "metrics": [
        123
      ],
      "dimensions": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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,

first_cited_at

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,

quarter,

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 or dimension
- `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.

Show child attributes

Examples:

{ "date": "asc" }

{ "count": "desc", "date": "asc" }

pagination

Pagination · object

Pagination settings for the report results.

Show child attributes

filters

List of filters to apply to the citations report.

Filter by hostname

Show child attributes

Response

Successful Response

info

Info · object

required

Base model for report information.

Show child attributes

data

CitationsResult · object[]

required

Show child attributes

⌘I

Overview

SDKs

Integrations

Agents

Organization

Categories

Prompts

Knowledge Bases

OpenAI Ads

Answers

Reports

Content Optimization

Authorizations

Body

Response