Open in ChatGPT
View as Markdown

Aggregated analytics for the integration

GET /v1/analytics
Base URL 
https://api.isnotai.com
Available Regions 2 regions

Query Parameters

period
string

Time window: 24h, 7d (default), 30d, 90d.

groupBy
string

Time-series bucket size: hour, day (default), week.

Responses

200 application/json

Payload of AnalyticsResponse

Show 1 response attribute Hide response attributes
data
object
Show 11 data attributes Hide data attributes
period
string
groupBy
string
startDate
string(date-time)
endDate
string(date-time)
generatedAt
string(date-time)
summary
object
Show 6 summary attributes Hide summary attributes
totalSessions
integer(int32)
totalEvents
integer(int32)
uniqueBots
integer(int32)
uniqueUsers
integer(int32)
averageBotScore
number(double)
averageEventsPerSession
number(double)
timeSeries
array[object]
Show 5 timeSeries attributes Hide timeSeries attributes
timestamp
string(date-time)
sessionCount
integer(int32)
eventCount
integer(int32)
botCount
integer(int32)
userMatchedCount
integer(int32)
botDetection
object
Show 4 botDetection attributes Hide botDetection attributes
highConfidenceBots
integer(int32)
mediumConfidenceBots
integer(int32)
lowConfidenceBots
integer(int32)
likelyHumans
integer(int32)
userMatching
object
Show 4 userMatching attributes Hide userMatching attributes
totalMatched
integer(int32)
totalUnmatched
integer(int32)
matchRate
number(double)
averageCorrelationConfidence
number(double)
topOrigins
array[object]
Show 3 topOrigins attributes Hide topOrigins attributes
origin
string
sessionCount
integer(int32)
botPercentage
number(double)
deviceBreakdown
object
Show 4 deviceBreakdown attributes Hide deviceBreakdown attributes
mobile
integer(int32)
tablet
integer(int32)
desktop
integer(int32)
browserCounts
object
400 application/json

Payload of ErrorEnvelope

Show 1 response attribute Hide response attributes
error
object
Show 3 error attributes Hide error attributes
code
string
message
string
details
object
401 application/json

Payload of ErrorEnvelope

Show 1 response attribute Hide response attributes
error
object
Show 3 error attributes Hide error attributes
code
string
message
string
details
object
GET /v1/analytics 
curl --request GET \
  --url https://api.isnotai.com/v1/analytics \
  --header 'Authorization: Bearer aik_v1_YOUR_API_KEY'
import requests

url = "https://api.isnotai.com/v1/analytics"

headers = {"Authorization": "Bearer aik_v1_YOUR_API_KEY"}

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

print(response.json())
const fetch = require('node-fetch');

const url = 'https://api.isnotai.com/v1/analytics';
const options = {method: 'GET', headers: {Authorization: 'Bearer aik_v1_YOUR_API_KEY'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.isnotai.com/v1/analytics"),
    Headers =
    {
        { "Authorization", "Bearer aik_v1_YOUR_API_KEY" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Try it

Collapse

Sent to the API as Authorization: Bearer aik_v1_.... Held only in this tab's input element; re-enter on each browser tab. The docs site never receives or stores it.

Query parameters

Time window: 24h, 7d (default), 30d, 90d.

Time-series bucket size: hour, day (default), week.

200 Response examples 
{
  "data": {
    "period": "string",
    "groupBy": "string",
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-01-01T00:00:00Z",
    "generatedAt": "2024-01-01T00:00:00Z",
    "summary": {
      "totalSessions": 0,
      "totalEvents": 0,
      "uniqueBots": 0,
      "uniqueUsers": 0,
      "averageBotScore": 0,
      "averageEventsPerSession": 0
    },
    "timeSeries": [
      {
        "timestamp": "2024-01-01T00:00:00Z",
        "sessionCount": 0,
        "eventCount": 0,
        "botCount": 0,
        "userMatchedCount": 0
      }
    ],
    "botDetection": {
      "highConfidenceBots": 0,
      "mediumConfidenceBots": 0,
      "lowConfidenceBots": 0,
      "likelyHumans": 0
    },
    "userMatching": {
      "totalMatched": 0,
      "totalUnmatched": 0,
      "matchRate": 0,
      "averageCorrelationConfidence": 0
    },
    "topOrigins": [
      {
        "origin": "string",
        "sessionCount": 0,
        "botPercentage": 0
      }
    ],
    "deviceBreakdown": {
      "mobile": 0,
      "tablet": 0,
      "desktop": 0,
      "browserCounts": {}
    }
  }
}
400 Response examples 
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
401 Response examples 
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}