List visitor sessions for a Clics project via REST
List paginated visitor sessions. Supports the same period presets as /v1/query, optional domain scoping, and cursor pagination.
GET
/v1/projects/{project_id}/sessionsAuthorization
AuthorizationBearer token (API key) · headerrequiredPath parameters
project_idstringrequiredClics project ID.
min length 1
Query parameters
domainstringOptional domain filter (e.g. `example.com`). Schemes like `https://`, paths, and ports are stripped. Omit to query all production domains for the project (localhost/dev traffic is excluded by default). Pass "localhost" to query development traffic only.
min length 1
date_rangestringPeriod preset (last24h, last7days, last30days, last3months, last12months, monthToDate, quarterToDate, yearToDate, allTime). Ignored when both `start` and `end` are provided. Defaults to `last7days` for list, `allTime` for detail/events.
Allowed:
last24hlast7dayslast30dayslast3monthslast12monthsmonthToDatequarterToDateyearToDateallTimestartstringCustom range start (date-only `yyyy-MM-dd` or ISO8601). Must be paired with `end`.
min length 1
endstringCustom range end (date-only `yyyy-MM-dd` or ISO8601). Must be paired with `start`.
min length 1
timezonestringIANA timezone used for calendar period boundaries and session dates. 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/WallisUTCcountrystringComma-separated country values.
min length 1
country_opstringMatch operator. Defaults to `is` when a matching filter value is provided.
Allowed:
isis_notdevicestringComma-separated device values.
min length 1
device_opstringMatch operator. Defaults to `is` when a matching filter value is provided.
Allowed:
isis_notbrowserstringComma-separated browser values.
min length 1
browser_opstringMatch operator. Defaults to `is` when a matching filter value is provided.
Allowed:
isis_notosstringComma-separated operating system values.
min length 1
os_opstringMatch operator. Defaults to `is` when a matching filter value is provided.
Allowed:
isis_notpage_entrystringComma-separated landing pathname values.
min length 1
page_entry_opstringMatch operator. Defaults to `is` when a matching filter value is provided.
Allowed:
isis_notpage_exitstringComma-separated exit pathname values.
min length 1
page_exit_opstringMatch operator. Defaults to `is` when a matching filter value is provided.
Allowed:
isis_notreferrerstringComma-separated referrer values; use `direct` for direct traffic.
min length 1
referrer_opstringMatch operator. Defaults to `is` when a matching filter value is provided.
Allowed:
isis_notcursorstringOptional pagination cursor from a previous response.
limitintegerOptional page size (1–100). Defaults to 20.
min 1 · max 100
Responses
200Paginated sessions.
sessionsobject[]requiredShow propertiesHide properties
Array of
objectsession_idstringrequireddatestringrequiredfirst_hitstringrequiredlast_hitstringrequiredduration_secondsnumberrequiredpageviewsnumberrequiredis_bouncebooleanrequiredcountrystringrequireddevicestringrequiredbrowserstringrequiredosstringrequiredlanding_pathnamestringrequiredexit_pathnamestringrequiredreferrerstringrequiredmetaobjectrequiredShow propertiesHide properties
cursorstring | nullrequiredis_donebooleanrequiredtotal_rowsintegerrequiredmin 0
timezonestringrequired400Invalid request.
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringrequired401Missing or invalid API key.
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringrequired403Forbidden.
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringrequired404Resource not found.
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringrequired500Unexpected error.
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringrequiredRequest
curl -X GET "https://api.clics.dev/v1/projects/k17abc123/sessions" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://api.clics.dev/v1/projects/k17abc123/sessions", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_TOKEN"
}
});import requests
response = requests.get(
"https://api.clics.dev/v1/projects/k17abc123/sessions",
headers={
"Authorization": "Bearer YOUR_TOKEN"
},
)Response
{
"sessions": [
{
"session_id": "string",
"date": "string",
"first_hit": "string",
"last_hit": "string",
"duration_seconds": 0,
"pageviews": 0,
"is_bounce": true,
"country": "string",
"device": "string",
"browser": "string",
"os": "string",
"landing_pathname": "string",
"exit_pathname": "string",
"referrer": "string"
}
],
"meta": {
"cursor": "string",
"is_done": true,
"total_rows": 0,
"timezone": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}