PEpeec
Agent Analytics

List Referral Sources

Changed on

Every AI assistant Peec can attribute referral traffic to, whether or not this project has seen traffic from it — one row per referrer host, so an assistant reachable on several hosts appears once per host. Use assistant for the assistants filter on the referrals endpoint, and source to recognise a raw host in its results. The list is maintained by hand and reviewed quarterly, so a brand-new assistant may be missing.

get/agent-analytics/google-analytics/list-referral-sources

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/agent-analytics/google-analytics/list-referral-sources
  • 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

Response

Success

total_countnumber required

Example response

{
  "data": [
    {
      "source": "chatgpt.com",
      "assistant": "ChatGPT",
      "platform": "OpenAI"
    }
  ],
  "total_count": 78
}

Changes