Get verified AI crawler analytics for a Clics project

Return the production AI crawler dashboard data for a project, including category totals, timeseries, dashboard breakdowns, and available filter values.

GET/v1/projects/{project_id}/ai-crawlers

Authorization

AuthorizationBearer token (API key) · headerrequired

Path parameters

project_idstringrequired

Clics project ID.

min length 1

Query parameters

date_rangestring

Period preset. Ignored when both `start` and `end` are provided.

default: "last7days"

Allowed:last24hlast7dayslast30dayslast3monthslast12monthsmonthToDatequarterToDateyearToDateallTime

startstring

Custom range start (date-only `yyyy-MM-dd` or ISO8601). Must be paired with `end`.

min length 1

endstring

Custom range end (date-only `yyyy-MM-dd` or ISO8601). Must be paired with `start`.

min length 1

timezonestring

IANA timezone used for calendar period boundaries. Defaults to `UTC`.

default: "UTC"

Allowed:Africa/AbidjanAfrica/AccraAfrica/Addis_AbabaAfrica/AlgiersAfrica/AsmeraAfrica/BamakoAfrica/BanguiAfrica/BanjulAfrica/BissauAfrica/BlantyreAfrica/BrazzavilleAfrica/BujumburaAfrica/CairoAfrica/CasablancaAfrica/CeutaAfrica/ConakryAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/DoualaAfrica/El_AaiunAfrica/FreetownAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KampalaAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LomeAfrica/LuandaAfrica/LubumbashiAfrica/LusakaAfrica/MalaboAfrica/MaputoAfrica/MaseruAfrica/MbabaneAfrica/MogadishuAfrica/MonroviaAfrica/NairobiAfrica/NdjamenaAfrica/NiameyAfrica/NouakchottAfrica/OuagadougouAfrica/Porto-NovoAfrica/Sao_TomeAfrica/TripoliAfrica/TunisAfrica/WindhoekAmerica/AdakAmerica/AnchorageAmerica/AnguillaAmerica/AntiguaAmerica/AraguainaAmerica/Argentina/La_RiojaAmerica/Argentina/Rio_GallegosAmerica/Argentina/SaltaAmerica/Argentina/San_JuanAmerica/Argentina/San_LuisAmerica/Argentina/TucumanAmerica/Argentina/UshuaiaAmerica/ArubaAmerica/AsuncionAmerica/BahiaAmerica/Bahia_BanderasAmerica/BarbadosAmerica/BelemAmerica/BelizeAmerica/Blanc-SablonAmerica/Boa_VistaAmerica/BogotaAmerica/BoiseAmerica/Buenos_AiresAmerica/Cambridge_BayAmerica/Campo_GrandeAmerica/CancunAmerica/CaracasAmerica/CatamarcaAmerica/CayenneAmerica/CaymanAmerica/ChicagoAmerica/ChihuahuaAmerica/Ciudad_JuarezAmerica/Coral_HarbourAmerica/CordobaAmerica/Costa_RicaAmerica/CoyhaiqueAmerica/CrestonAmerica/CuiabaAmerica/CuracaoAmerica/DanmarkshavnAmerica/DawsonAmerica/Dawson_CreekAmerica/DenverAmerica/DetroitAmerica/DominicaAmerica/EdmontonAmerica/EirunepeAmerica/El_SalvadorAmerica/Fort_NelsonAmerica/FortalezaAmerica/Glace_BayAmerica/GodthabAmerica/Goose_BayAmerica/Grand_TurkAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/GuayaquilAmerica/GuyanaAmerica/HalifaxAmerica/HavanaAmerica/HermosilloAmerica/Indiana/KnoxAmerica/Indiana/MarengoAmerica/Indiana/PetersburgAmerica/Indiana/Tell_CityAmerica/Indiana/VevayAmerica/Indiana/VincennesAmerica/Indiana/WinamacAmerica/IndianapolisAmerica/InuvikAmerica/IqaluitAmerica/JamaicaAmerica/JujuyAmerica/JuneauAmerica/Kentucky/MonticelloAmerica/KralendijkAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/LouisvilleAmerica/Lower_PrincesAmerica/MaceioAmerica/ManaguaAmerica/ManausAmerica/MarigotAmerica/MartiniqueAmerica/MatamorosAmerica/MazatlanAmerica/MendozaAmerica/MenomineeAmerica/MeridaAmerica/MetlakatlaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/NomeAmerica/NoronhaAmerica/North_Dakota/BeulahAmerica/North_Dakota/CenterAmerica/North_Dakota/New_SalemAmerica/OjinagaAmerica/PanamaAmerica/ParamariboAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/Porto_VelhoAmerica/Puerto_RicoAmerica/Punta_ArenasAmerica/Rankin_InletAmerica/RecifeAmerica/ReginaAmerica/ResoluteAmerica/Rio_BrancoAmerica/SantaremAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ScoresbysundAmerica/SitkaAmerica/St_BarthelemyAmerica/St_JohnsAmerica/St_KittsAmerica/St_LuciaAmerica/St_ThomasAmerica/St_VincentAmerica/Swift_CurrentAmerica/TegucigalpaAmerica/ThuleAmerica/TijuanaAmerica/TorontoAmerica/TortolaAmerica/VancouverAmerica/WhitehorseAmerica/WinnipegAmerica/YakutatAntarctica/CaseyAntarctica/DavisAntarctica/DumontDUrvilleAntarctica/MacquarieAntarctica/MawsonAntarctica/McMurdoAntarctica/PalmerAntarctica/RotheraAntarctica/SyowaAntarctica/TrollAntarctica/VostokArctic/LongyearbyenAsia/AdenAsia/AlmatyAsia/AmmanAsia/AnadyrAsia/AqtauAsia/AqtobeAsia/AshgabatAsia/AtyrauAsia/BaghdadAsia/BahrainAsia/BakuAsia/BangkokAsia/BarnaulAsia/BeirutAsia/BishkekAsia/BruneiAsia/CalcuttaAsia/ChitaAsia/ColomboAsia/DamascusAsia/DhakaAsia/DiliAsia/DubaiAsia/DushanbeAsia/FamagustaAsia/GazaAsia/HebronAsia/Hong_KongAsia/HovdAsia/IrkutskAsia/JakartaAsia/JayapuraAsia/JerusalemAsia/KabulAsia/KamchatkaAsia/KarachiAsia/KatmanduAsia/KhandygaAsia/KrasnoyarskAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/MagadanAsia/MakassarAsia/ManilaAsia/MuscatAsia/NicosiaAsia/NovokuznetskAsia/NovosibirskAsia/OmskAsia/OralAsia/Phnom_PenhAsia/PontianakAsia/PyongyangAsia/QatarAsia/QostanayAsia/QyzylordaAsia/RangoonAsia/RiyadhAsia/SaigonAsia/SakhalinAsia/SamarkandAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/SrednekolymskAsia/TaipeiAsia/TashkentAsia/TbilisiAsia/TehranAsia/ThimphuAsia/TokyoAsia/TomskAsia/UlaanbaatarAsia/UrumqiAsia/Ust-NeraAsia/VientianeAsia/VladivostokAsia/YakutskAsia/YekaterinburgAsia/YerevanAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaeroeAtlantic/MadeiraAtlantic/ReykjavikAtlantic/South_GeorgiaAtlantic/St_HelenaAtlantic/StanleyAustralia/AdelaideAustralia/BrisbaneAustralia/Broken_HillAustralia/DarwinAustralia/EuclaAustralia/HobartAustralia/LindemanAustralia/Lord_HoweAustralia/MelbourneAustralia/PerthAustralia/SydneyEurope/AmsterdamEurope/AndorraEurope/AstrakhanEurope/AthensEurope/BelgradeEurope/BerlinEurope/BratislavaEurope/BrusselsEurope/BucharestEurope/BudapestEurope/BusingenEurope/ChisinauEurope/CopenhagenEurope/DublinEurope/GibraltarEurope/GuernseyEurope/HelsinkiEurope/Isle_of_ManEurope/IstanbulEurope/JerseyEurope/KaliningradEurope/KievEurope/KirovEurope/LisbonEurope/LjubljanaEurope/LondonEurope/LuxembourgEurope/MadridEurope/MaltaEurope/MariehamnEurope/MinskEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PodgoricaEurope/PragueEurope/RigaEurope/RomeEurope/SamaraEurope/San_MarinoEurope/SarajevoEurope/SaratovEurope/SimferopolEurope/SkopjeEurope/SofiaEurope/StockholmEurope/TallinnEurope/TiraneEurope/UlyanovskEurope/VaduzEurope/VaticanEurope/ViennaEurope/VilniusEurope/VolgogradEurope/WarsawEurope/ZagrebEurope/ZurichIndian/AntananarivoIndian/ChagosIndian/ChristmasIndian/CocosIndian/ComoroIndian/KerguelenIndian/MaheIndian/MaldivesIndian/MauritiusIndian/MayotteIndian/ReunionPacific/ApiaPacific/AucklandPacific/BougainvillePacific/ChathamPacific/EasterPacific/EfatePacific/EnderburyPacific/FakaofoPacific/FijiPacific/FunafutiPacific/GalapagosPacific/GambierPacific/GuadalcanalPacific/GuamPacific/HonoluluPacific/KiritimatiPacific/KosraePacific/KwajaleinPacific/MajuroPacific/MarquesasPacific/MidwayPacific/NauruPacific/NiuePacific/NorfolkPacific/NoumeaPacific/Pago_PagoPacific/PalauPacific/PitcairnPacific/PonapePacific/Port_MoresbyPacific/RarotongaPacific/SaipanPacific/TahitiPacific/TarawaPacific/TongatapuPacific/TrukPacific/WakePacific/WallisUTC

categorystring

Crawler category tab.

default: "answer_fetch"

Allowed:answer_fetchsearch_indextraining

providerstring | string[]

Crawler provider or providers.

provider_opstring

Provider filter operator.

default: "is"

Allowed:isis_not

crawlerstring | string[]

Crawler name or names.

crawler_opstring

Crawler filter operator.

default: "is"

Allowed:isis_not

statusstring

Comma-separated HTTP status codes; 0 means unknown.

min length 1

status_opstring

Status filter operator.

default: "is"

Allowed:isis_not

breakdown_limitinteger

Maximum rows for each breakdown.

min 1 · max 200 · default: 50

filter_values_limitinteger

Maximum rows for each filter value list.

min 1 · max 200 · default: 200

Responses

200AI crawler analytics dashboard data.

has_eventsbooleanrequired

categoriesobject[]required

Show properties

Array of object

categorystringrequired

crawlsnumberrequired

previous_crawlsnumberrequired

change_percentnumberrequired

timeseriesobject[]required

Show properties

Array of object

datestringrequired

crawlsnumberrequired

breakdownsobjectrequired

Show properties

providersobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

crawlersobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

pagesobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

urlsobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

statusesobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

filter_valuesobjectrequired

Show properties

providersobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

crawlersobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

statusesobject[]required

Show properties

Array of object

valuestringrequired

labelstringrequired

crawlsnumberrequired

metaobjectrequired

Show properties

environmentstringrequired

Allowed:production

timezonestringrequired

categorystringrequired

Allowed:answer_fetchsearch_indextraining

date_rangestring | any[]required

Show properties

Any of:

string

string

any[]

Array of any

queryobjectrequired

400Invalid request.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

401Missing or invalid API key.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

403Forbidden.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

500Unexpected error.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

503Unexpected error.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

Request

curl -X GET "https://api.clics.dev/v1/projects/k17abc123/ai-crawlers" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.clics.dev/v1/projects/k17abc123/ai-crawlers", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.clics.dev/v1/projects/k17abc123/ai-crawlers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "has_events": true,
  "categories": [
    {
      "category": "string",
      "crawls": 0,
      "previous_crawls": 0,
      "change_percent": 0
    }
  ],
  "timeseries": [
    {
      "date": "string",
      "crawls": 0
    }
  ],
  "breakdowns": {
    "providers": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ],
    "crawlers": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ],
    "pages": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ],
    "urls": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ],
    "statuses": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ]
  },
  "filter_values": {
    "providers": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ],
    "crawlers": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ],
    "statuses": [
      {
        "value": "string",
        "label": "string",
        "crawls": 0
      }
    ]
  },
  "meta": {
    "environment": "production",
    "timezone": "string",
    "category": "answer_fetch",
    "date_range": "last24h"
  },
  "query": {}
}