Get Bots Report V2

curl --request POST \
  --url https://api.tryprofound.com/v2/reports/bots \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metrics": [],
  "domain": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "date_interval": "day",
  "dimensions": [],
  "order_by": {
    "date": "asc"
  },
  "pagination": {
    "limit": 10000,
    "offset": 0
  },
  "end_date": "2023-11-07T05:31:56Z",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timezone": "UTC",
  "view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metric_filters": [
    {
      "field": "<string>",
      "value": 123
    }
  ],
  "filters": [
    {
      "field": "path",
      "value": "<string>"
    }
  ],
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.tryprofound.com/v2/reports/bots"

payload = {
    "metrics": [],
    "domain": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "date_interval": "day",
    "dimensions": [],
    "order_by": { "date": "asc" },
    "pagination": {
        "limit": 10000,
        "offset": 0
    },
    "end_date": "2023-11-07T05:31:56Z",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timezone": "UTC",
    "view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metric_filters": [
        {
            "field": "<string>",
            "value": 123
        }
    ],
    "filters": [
        {
            "field": "path",
            "value": "<string>"
        }
    ],
    "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tags": ["<string>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metrics: [],
    domain: '<string>',
    start_date: '2023-11-07T05:31:56Z',
    date_interval: 'day',
    dimensions: [],
    order_by: {date: 'asc'},
    pagination: {limit: 10000, offset: 0},
    end_date: '2023-11-07T05:31:56Z',
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    timezone: 'UTC',
    view_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    metric_filters: [{field: '<string>', value: 123}],
    filters: [{field: 'path', value: '<string>'}],
    domain_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tags: ['<string>']
  })
};

fetch('https://api.tryprofound.com/v2/reports/bots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v2/reports/bots",
  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' => [
        
    ],
    'domain' => '<string>',
    'start_date' => '2023-11-07T05:31:56Z',
    'date_interval' => 'day',
    'dimensions' => [
        
    ],
    'order_by' => [
        'date' => 'asc'
    ],
    'pagination' => [
        'limit' => 10000,
        'offset' => 0
    ],
    'end_date' => '2023-11-07T05:31:56Z',
    'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'timezone' => 'UTC',
    'view_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'metric_filters' => [
        [
                'field' => '<string>',
                'value' => 123
        ]
    ],
    'filters' => [
        [
                'field' => 'path',
                'value' => '<string>'
        ]
    ],
    'domain_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tags' => [
        '<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/v2/reports/bots"

	payload := strings.NewReader("{\n  \"metrics\": [],\n  \"domain\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {\n    \"date\": \"asc\"\n  },\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"UTC\",\n  \"view_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metric_filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"path\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\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/v2/reports/bots")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metrics\": [],\n  \"domain\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {\n    \"date\": \"asc\"\n  },\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"UTC\",\n  \"view_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metric_filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"path\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tryprofound.com/v2/reports/bots")

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  \"domain\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {\n    \"date\": \"asc\"\n  },\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"UTC\",\n  \"view_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metric_filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"path\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\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": {}
    }
  ]
}

Bot Traffic

Get Bots Report V2

Get bot traffic report from the hourly aggregated materialized view (UTC-based).

Supports date_interval=“hour”, calendar intervals through “year”, “quarter”, and “relative_week”. When view_id is provided, the query is scoped to that domain segment’s hosts and paths.

Metrics:

count: unique bot visits
citations: unique citation events (ai_assistant bot type)
indexing: unique indexing events (index bot type)
training: unique training events (ai_training bot type)
last_visit: most recent visit timestamp

Dimensions:

date, path, bot_name, bot_provider, bot_type

POST

reports

bots

Get Bots Report V2

curl --request POST \
  --url https://api.tryprofound.com/v2/reports/bots \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metrics": [],
  "domain": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "date_interval": "day",
  "dimensions": [],
  "order_by": {
    "date": "asc"
  },
  "pagination": {
    "limit": 10000,
    "offset": 0
  },
  "end_date": "2023-11-07T05:31:56Z",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timezone": "UTC",
  "view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metric_filters": [
    {
      "field": "<string>",
      "value": 123
    }
  ],
  "filters": [
    {
      "field": "path",
      "value": "<string>"
    }
  ],
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.tryprofound.com/v2/reports/bots"

payload = {
    "metrics": [],
    "domain": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "date_interval": "day",
    "dimensions": [],
    "order_by": { "date": "asc" },
    "pagination": {
        "limit": 10000,
        "offset": 0
    },
    "end_date": "2023-11-07T05:31:56Z",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timezone": "UTC",
    "view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metric_filters": [
        {
            "field": "<string>",
            "value": 123
        }
    ],
    "filters": [
        {
            "field": "path",
            "value": "<string>"
        }
    ],
    "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tags": ["<string>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metrics: [],
    domain: '<string>',
    start_date: '2023-11-07T05:31:56Z',
    date_interval: 'day',
    dimensions: [],
    order_by: {date: 'asc'},
    pagination: {limit: 10000, offset: 0},
    end_date: '2023-11-07T05:31:56Z',
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    timezone: 'UTC',
    view_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    metric_filters: [{field: '<string>', value: 123}],
    filters: [{field: 'path', value: '<string>'}],
    domain_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tags: ['<string>']
  })
};

fetch('https://api.tryprofound.com/v2/reports/bots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v2/reports/bots",
  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' => [
        
    ],
    'domain' => '<string>',
    'start_date' => '2023-11-07T05:31:56Z',
    'date_interval' => 'day',
    'dimensions' => [
        
    ],
    'order_by' => [
        'date' => 'asc'
    ],
    'pagination' => [
        'limit' => 10000,
        'offset' => 0
    ],
    'end_date' => '2023-11-07T05:31:56Z',
    'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'timezone' => 'UTC',
    'view_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'metric_filters' => [
        [
                'field' => '<string>',
                'value' => 123
        ]
    ],
    'filters' => [
        [
                'field' => 'path',
                'value' => '<string>'
        ]
    ],
    'domain_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tags' => [
        '<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/v2/reports/bots"

	payload := strings.NewReader("{\n  \"metrics\": [],\n  \"domain\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {\n    \"date\": \"asc\"\n  },\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"UTC\",\n  \"view_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metric_filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"path\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\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/v2/reports/bots")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metrics\": [],\n  \"domain\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {\n    \"date\": \"asc\"\n  },\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"UTC\",\n  \"view_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metric_filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"path\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tryprofound.com/v2/reports/bots")

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  \"domain\": \"<string>\",\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"date_interval\": \"day\",\n  \"dimensions\": [],\n  \"order_by\": {\n    \"date\": \"asc\"\n  },\n  \"pagination\": {\n    \"limit\": 10000,\n    \"offset\": 0\n  },\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"timezone\": \"UTC\",\n  \"view_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metric_filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": 123\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"path\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\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> | string)[]

required

Available options:

count,

citations,

indexing,

training,

last_visit

domain

string

required

Domain to query logs for.

start_date

string<date-time>

required

Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, 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:

date,

hour,

host,

path,

bot_name,

bot_provider,

bot_type

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

Example:

{ "date": "asc" }

pagination

Pagination · object

Pagination settings for the report results.

Show child attributes

end_date

string<date-time>

End date in UTC. Accepts same formats as start_date. Defaults to now UTC if omitted.

organization_id

string<uuid> | null

timezone

string

default:UTC

IANA timezone name for date bucketing and filter boundaries.

view_id

string<uuid> | null

Domain segment UUID used to scope the query to a configured subset of hosts and paths.

metric_filters

NumericMetricFilter · object[]

Numeric filters applied after report metrics are calculated.

Show child attributes

filters

(PathFilter · object | BotNameFilter · object | BotProviderFilter · object | BotTypeFilter · object)[]

Filters for bots report.

Filter by request path

PathFilter
BotNameFilter
BotProviderFilter
BotTypeFilter

Show child attributes

domain_id

string<uuid> | null

Domain UUID used for tag lookups.

Response

Successful Response

Base response model for reports.

info

Info · object

required

Base model for report information.

Show child attributes

data

Result · object[]

required

Show child attributes

Overview

SDKs

Integrations

Agents

Organization

Categories

Prompts

Knowledge Bases

OpenAI Ads

Answers

Reports

Content Optimization

Get Bots Report V2

Authorizations

Body

Response