web

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-web"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/c98607d6-613a-4769-ba8d-1fd655470740/social-card.svg?v=3e7ae33eec8b" alt="web" width="600" height="315"></a>
GEThttps://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/web/rollup

Parameters

org_idstringpathrequired
projectsstringquery
comma separated project ids; default every readable project
fromstringquery
tostringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/orgs/{org_id}/web/rollup"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "from": "2024-01-01T00:00:00Z",
  "people": "string",
  "sites": [
    {
      "name": "string",
      "overview": {
        "current": {
          "avg_engagement_time_s": 0,
          "avg_events_per_session": 0,
          "avg_session_duration_s": 0,
          "bounce_rate": 0,
          "engaged_sessions": 0,
          "engagement_rate": 0,
          "pageviews": 0,
          "sessions": 0,
          "views_per_session": 0,
          "visitors": 0
        },
        "delta": {
          "avg_engagement_time_s": 0,
          "avg_events_per_session": 0,
          "avg_session_duration_s": 0,
          "bounce_rate": 0,
          "engaged_sessions": 0,
          "engagement_rate": 0,
          "pageviews": 0,
          "sessions": 0,
          "views_per_session": 0,
          "visitors": 0
        },
        "precomputed": {
          "computed_at": "string",
          "through": "2024-01-01T00:00:00Z"
        },
        "previous": {
          "avg_engagement_time_s": 0,
          "avg_events_per_session": 0,
          "avg_session_duration_s": 0,
          "bounce_rate": 0,
          "engaged_sessions": 0,
          "engagement_rate": 0,
          "pageviews": 0,
          "sessions": 0,
          "views_per_session": 0,
          "visitors": 0
        }
      },
      "project_id": "string"
    }
  ],
  "to": "2024-01-01T00:00:00Z",
  "total": {
    "current": {
      "avg_engagement_time_s": 0,
      "avg_events_per_session": 0,
      "avg_session_duration_s": 0,
      "bounce_rate": 0,
      "engaged_sessions": 0,
      "engagement_rate": 0,
      "pageviews": 0,
      "sessions": 0,
      "views_per_session": 0,
      "visitors": 0
    },
    "delta": {
      "avg_engagement_time_s": 0,
      "avg_events_per_session": 0,
      "avg_session_duration_s": 0,
      "bounce_rate": 0,
      "engaged_sessions": 0,
      "engagement_rate": 0,
      "pageviews": 0,
      "sessions": 0,
      "views_per_session": 0,
      "visitors": 0
    },
    "precomputed": {
      "computed_at": "string",
      "through": "2024-01-01T00:00:00Z"
    },
    "previous": {
      "avg_engagement_time_s": 0,
      "avg_events_per_session": 0,
      "avg_session_duration_s": 0,
      "bounce_rate": 0,
      "engaged_sessions": 0,
      "engagement_rate": 0,
      "pageviews": 0,
      "sessions": 0,
      "views_per_session": 0,
      "visitors": 0
    }
  }
}
Schema
fromstringrequired
peoplestringrequired
deduplicated (visitors counted once across sites) or summed.
sitesSiteOverview[]required
One entry per included project, in the order requested (default: project creation order).
Show child parameters
namestringrequired
overviewobjectrequired
Show child parameters
currentobjectrequired
deltaOverviewDelta
precomputedPrecomputed
previousOverview
project_idstringrequired
tostringrequired
totalobjectrequired
Sum of the sites; rates weighted by sessions. previous and delta cover the same sites.
Show child parameters
currentobjectrequired
Show child parameters
avg_engagement_time_snumber
Mean visible time per session in seconds; only sessions that measured it count.
avg_events_per_sessionnumber
avg_session_duration_snumber
bounce_ratenumber
Share of sessions with at most one pageview (0..1).
engaged_sessionsintegerrequired
Sessions with two or more pageviews, ten seconds on the clock, or ten seconds of measured engagement.
engagement_ratenumber
engaged_sessions / sessions (0..1).
pageviewsintegerrequired
sessionsintegerrequired
views_per_sessionnumber
visitorsintegerrequired
deltaOverviewDelta
Show child parameters
avg_engagement_time_snumber
avg_events_per_sessionnumber
avg_session_duration_snumber
bounce_ratenumber
engaged_sessionsnumber
engagement_ratenumber
pageviewsnumber
sessionsnumber
views_per_sessionnumber
visitorsnumber
precomputedPrecomputed
Show child parameters
computed_atstringrequired
When the oldest precomputed day used was computed.
throughstringrequired
Precomputed up to this UTC midnight; later data was read live.
previousOverview
Show child parameters
avg_engagement_time_snumber
Mean visible time per session in seconds; only sessions that measured it count.
avg_events_per_sessionnumber
avg_session_duration_snumber
bounce_ratenumber
Share of sessions with at most one pageview (0..1).
engaged_sessionsintegerrequired
Sessions with two or more pageviews, ten seconds on the clock, or ten seconds of measured engagement.
engagement_ratenumber
engaged_sessions / sessions (0..1).
pageviewsintegerrequired
sessionsintegerrequired
views_per_sessionnumber
visitorsintegerrequired
400
404 Unknown org, or any named project is not readable by the caller
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/bot-traffic

Parameters

project_idstringpathrequired
fromstringpathrequired
Default: 30 days before to.
tostringpathrequired
group_bystringpathrequired
Trend grouping: crawler (default) | category | host | path.
hoststringpathrequired
Only this host ($host).

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/bot-traffic"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "categories": [
    {
      "events": 0,
      "key": "string"
    }
  ],
  "crawlers": [
    {
      "category": "string",
      "events": 0,
      "last_seen": "string",
      "name": "string",
      "operator": "string",
      "paths": 0,
      "traffic_type": "string"
    }
  ],
  "days": [
    {
      "ai_agent_events": 0,
      "automation_events": 0,
      "bot_events": 0,
      "day": "string",
      "total_events": 0
    }
  ],
  "hosts": [
    {
      "events": 0,
      "key": "string"
    }
  ],
  "paths": [
    {
      "crawlers": 0,
      "events": 0,
      "path": "string"
    }
  ],
  "top_clients": [
    {
      "browser": "string",
      "events": 0
    }
  ],
  "trend": [
    {
      "day": "string",
      "events": 0,
      "key": "string"
    }
  ]
}
Schema
categoriesBotCount[]required
Show child parameters
eventsintegerrequired
keystringrequired
crawlersBotCrawler[]required
Busiest first (at most 50).
Show child parameters
categorystringrequired
eventsintegerrequired
last_seenstringrequired
RFC 3339.
namestringrequired
operatorstringrequired
pathsintegerrequired
traffic_typestringrequired
ai_agent | bot | automation
daysBotDay[]required
Oldest first.
Show child parameters
ai_agent_eventsintegerrequired
Bot events split by traffic type.
automation_eventsintegerrequired
bot_eventsintegerrequired
daystringrequired
YYYY-MM-DD
total_eventsintegerrequired
hostsBotCount[]required
At most 10.
Show child parameters
eventsintegerrequired
keystringrequired
pathsBotPath[]required
At most 20.
Show child parameters
crawlersintegerrequired
Distinct crawlers that fetched it.
eventsintegerrequired
pathstringrequired
top_clientsBotBrowser[]required
Bot events by detected browser / client, busiest first (at most 10).
Show child parameters
browserstringrequired
eventsintegerrequired
trendBotTrendPoint[]required
Daily events of the top five keys of group_by.
Show child parameters
daystringrequired
eventsintegerrequired
keystringrequired
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics

Parameters

project_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 settings, attributes (every classified page) and the vocabulary
{}
404
PUThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics

Parameters

project_idstringpathrequired

Request body

application/json

enabled, site_url (origin the pages are fetched from), max_pages 1..=200 per daily run

{}

Code samples

cURL
curl -X PUT "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 
{}
400
403
404
PUThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics/attributes

Parameters

project_idstringpathrequired

Request body

application/json

data: up to 200 {path, topic, cta_type, imagery, content_type, model}

{}

Code samples

cURL
curl -X PUT "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics/attributes" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
400
403
404
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics/attributes

Parameters

project_idstringpathrequired
pathstringqueryrequired

Code samples

cURL
curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics/attributes?path=<path>"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
403
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics/report

Parameters

project_idstringpathrequired
attributestringquery
topic (default) | cta_type | imagery | content_type
fromstringquery
tostringquery
limitintegerquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/content-analytics/report"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 data: {value, pageviews, visitors, sessions, pages}; value "" = not classified
{}
400
404
503

Updated