PEpeec
Project

List Agent logs

Changed on

List Agent access logs from your log provider integration or access file upload, oldest first.

get/agent-analytics/logs

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/agent-analytics/logs
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb
limitinteger
offsetinteger
start_datestring date

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

Example:2025-09-22
end_datestring date

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

Example:2025-09-22
bot_idsstring[]

List of bot IDs to filter by. you will get it from /agent-analytics/bots

[
  "AppleBot",
  "GoogleBot"
]

Response

Response for status 200

total_countnumber required

Total number of agent logs in storage

totalCountnumber required

Total number of agent logs in storage

Example response

{
  "data": [
    {
      "bot_id": "AppleBot",
      "timestamp": "2025-01-01T00:01:02.000Z",
      "request_method": "GET",
      "request_host": "example.com",
      "request_path": "/path",
      "response_status": 200,
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Safari/605.1.15 (Applebot/0.1; +http://www.apple.com/go/applebot)",
      "client_ip": "127.0.0.1",
      "referer": "notexample.com"
    }
  ],
  "total_count": 100,
  "totalCount": 100
}

Changes

  • 9fdffdff48a5Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      for the query request parameter offset, the type changed from number to integer

    • warning

      for the query request parameter offset, the max was set to 9007199254740991.00

    • info

      added the enum value Brightbot to the property items/ of the query request parameter bot_ids