Visited Pages

Return pages visited by AI crawlers and agents.

curl -X GET "https://api.beacon.hard.al/v1/reports/ai-visibility/page-report?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&path=example_string&channel=example_string&source=example_string&device=example_string&os=example_string&country=USA&city=New%20York&eventName=John%20Doe&isAi=true&agentType=example_string&agentName=John%20Doe&agentPlatform=example_string&agentCategory=example_string&pagePath=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://api.beacon.hard.al/v1/reports/ai-visibility/page-report?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&path=example_string&channel=example_string&source=example_string&device=example_string&os=example_string&country=USA&city=New%20York&eventName=John%20Doe&isAi=true&agentType=example_string&agentName=John%20Doe&agentPlatform=example_string&agentCategory=example_string&pagePath=example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.beacon.hard.al/v1/reports/ai-visibility/page-report?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&path=example_string&channel=example_string&source=example_string&device=example_string&os=example_string&country=USA&city=New%20York&eventName=John%20Doe&isAi=true&agentType=example_string&agentName=John%20Doe&agentPlatform=example_string&agentCategory=example_string&pagePath=example_string", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.beacon.hard.al/v1/reports/ai-visibility/page-report?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&path=example_string&channel=example_string&source=example_string&device=example_string&os=example_string&country=USA&city=New%20York&eventName=John%20Doe&isAi=true&agentType=example_string&agentName=John%20Doe&agentPlatform=example_string&agentCategory=example_string&pagePath=example_string", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.beacon.hard.al/v1/reports/ai-visibility/page-report?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&path=example_string&channel=example_string&source=example_string&device=example_string&os=example_string&country=USA&city=New%20York&eventName=John%20Doe&isAi=true&agentType=example_string&agentName=John%20Doe&agentPlatform=example_string&agentCategory=example_string&pagePath=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "success": true,
  "data": {
    "range": {
      "startDate": "2026-10-01",
      "endDate": "2026-10-07",
      "timezone": "Europe/Istanbul"
    },
    "rows": [
      {
        "pagePath": "/",
        "agentPlatform": "Google",
        "agentName": "Googlebot",
        "agentCategory": "search-bot",
        "isAi": false,
        "visits": 630
      },
      {
        "pagePath": "/pricing",
        "agentPlatform": "OpenAI",
        "agentName": "GPTBot",
        "agentCategory": "ai-crawler",
        "isAi": true,
        "visits": 315
      },
      {
        "pagePath": "/blog",
        "agentPlatform": "Anthropic",
        "agentName": "ClaudeBot",
        "agentCategory": "ai-crawler",
        "isAi": true,
        "visits": 210
      },
      {
        "pagePath": "/product",
        "agentPlatform": "Perplexity",
        "agentName": "PerplexityBot",
        "agentCategory": "ai-search-crawler",
        "isAi": true,
        "visits": 105
      }
    ]
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-required",
    "message": "tenant-required"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "validation-error",
    "message": "Validation failed for 'timeframe': timeframe must be one of: today, yesterday, last7days, last30days, custom",
    "details": {
      "field": "timeframe",
      "message": "timeframe must be one of: today, yesterday, last7days, last30days, custom"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "bearer-required",
    "message": "bearer-required"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "invalid-credential",
    "message": "invalid-credential"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "credential-revoked",
    "message": "credential-revoked"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "credential-expired",
    "message": "credential-expired"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-not-granted",
    "message": "tenant-not-granted",
    "details": {
      "tenantId": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "source-does-not-belong-to-tenant",
    "message": "source-does-not-belong-to-tenant"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "insufficient-scope",
    "message": "insufficient-scope",
    "details": {
      "required": "reports:read"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-not-found",
    "message": "tenant-not-found",
    "details": {
      "tenantId": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "source-not-found",
    "message": "source-not-found",
    "details": {
      "sourceId": "7b0e5a54-1d43-4c8e-8d2f-5a9c3e6b1f27"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "rate-limited",
    "message": "rate-limited",
    "details": {
      "retryAfterSeconds": 30
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/ai-visibility/page-report",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

GET

/v1/reports/ai-visibility/page-report

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

OAuth access token (token exchange) or organization API key.

query

tenantIdstring

Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

Format: uuid

query

sourceIdstring

UUID of one source of the tenant. Omit it to include every source of the tenant.

Format: uuid

query

timeframestring

Reporting period. The presets today, yesterday, last7days and last30days cover whole calendar days ending today in the request timezone; last7days is today and the six days before it. Use custom together with startDate and endDate. Defaults to today.

query

startDatestring

First day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom, together with endDate.

query

endDatestring

Last day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom; it must not be before startDate.

query

timezonestring

IANA time zone name such as Europe/Istanbul or America/New_York. It sets the calendar-day boundaries of the period and of the time buckets. Defaults to Europe/Istanbul.

Min length: 1 • Max length: 100

query

intervalstring

Time bucket size: minute, hour, day, week or month.

query

pathstring

Page path, for example /pricing.

query

channelstring

Marketing channel, for example OrganicSearch.

query

sourcestring

Traffic source, for example google. This is not sourceId.

query

devicestring

Device type, for example desktop or mobile.

query

osstring

Operating system, for example iOS.

query

countrystring

Two-letter country code, for example TR.

query

citystring

City name, for example Istanbul.

query

eventNamestring

Event name, for example purchase.

query

isAistring

true returns AI agents only and false returns other crawlers only. Omit it for both.

query

agentTypestring

Agent type: ai or nonAi.

query

agentNamestring

Agent name, for example GPTBot.

query

agentPlatformstring

Company that runs the agent, for example OpenAI.

query

agentCategorystring

Agent category, for example ai-crawler or search-bot.

query

pagePathstring

Only count visits to this exact page path.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. OAuth access token (token exchange) or organization API key.

Query Parameters

tenantIdstring

Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

sourceIdstring

UUID of one source of the tenant. Omit it to include every source of the tenant.

timeframestring

startDatestring

First day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom, together with endDate.

endDatestring

Last day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom; it must not be before startDate.

timezonestring

IANA time zone name such as Europe/Istanbul or America/New_York. It sets the calendar-day boundaries of the period and of the time buckets. Defaults to Europe/Istanbul.

intervalstring

Time bucket size: minute, hour, day, week or month.

pathstring

Page path, for example /pricing.

channelstring

Marketing channel, for example OrganicSearch.

sourcestring

Traffic source, for example google. This is not sourceId.

devicestring

Device type, for example desktop or mobile.

osstring

Operating system, for example iOS.