Skip to main content
GET
/
agent-analytics
/
visits
Get Agent Visits
curl --request GET \
  --url https://api.peec.ai/customer/v1/agent-analytics/visits \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "bot_id": "GPTBot",
      "visits": 1402
    },
    {
      "bot_id": "AppleBot",
      "visits": 893
    }
  ],
  "totalCount": 2
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

​
limit
number
default:1000
Required range: 1 <= x <= 10000
​
offset
number
default:0
Required range: x >= 0
​
start_date
string<date>
default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2025-09-22"

​
end_date
string<date>
default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2025-09-22"

​
group_by
enum<string>[]

Dimension(s) to group visit counts by.

Available options:
bot_id,
response_status,
request_host,
request_path
Example:
["bot_id"]
​
bot_ids
string[]

Optional list of bot IDs to filter by.

Example:
["AppleBot", "GoogleBot"]
​
time_bucket
enum<string>

Optional time_bucket for grouping visits by time.

Available options:
hour,
day,
week,
month
Example:

"day"

Response

200 - application/json

Success

Success

​
data
object[]
required
​
totalCount
number
required

Total number of grouped rows.

Example:

10