---
title: "Get Agent Visits"
method: GET
path: "/agent-analytics/visits"
tags: ["Project"]
---

# Get Agent Visits

`GET /agent-analytics/visits`

Aggregate agent access log visits grouped by a chosen dimension (bot, response status, host, path).

## Query parameters

- `project_id` string — Required if using a company api key
- `limit` number
- `offset` number
- `start_date` string, date — full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
- `end_date` string, date — full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
- `group_by` string[] — Dimension(s) to group visit counts by.
- `bot_ids` string[] — Optional list of bot IDs to filter by.
- `time_bucket` 'hour' | 'day' | 'week' | 'month' — Optional time_bucket for grouping visits by time.

## Response `200`

Success

- object — Success
  - `data` object[], required
    - `bot_id` string
    - `response_status` number
    - `request_host` string
    - `time_bucket` string
    - `request_path` string
    - `visits` number, required
  - `total_count` number, required — Total number of grouped rows.
  - `totalCount` number, required — Total number of grouped rows.

---

[API](https://skmtc.net/peec/apis/peec-ai-customer-api.md) · [All operations](https://skmtc.net/peec/apis/peec-ai-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peec/peec-ai-customer-api/versions/92840a1bffa7/schema)