fastmon Docs
Analytics

Summarize the traffic around the live floor

Report an issue

Traffic per page type, today's totals, LCP per page type and the floor's shares.

The traffic blocks count the requested window, 5 minutes by default. The other blocks keep their own. Each block has its own server cache, so every tab of a scope shares one entry per block. meta.next_poll_ms sets the cadence.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token generated from the fastmon dashboard (Account → API Token) or at organization level (fmo_…, one that outlives its creator). Send as Authorization: Bearer fm_... or paste the full token (including its prefix) into the Authorize dialog.

Path Parameters

org_id*Org Id
Formatuuid

Request Body

application/json
  1. body

The scope of the live summary and the window of its traffic blocks.

filters?

Optional filters

window_seconds?LiveWindow

Length of the window traffic and traffic_total count, which ends now. performance and shares keep their own

Default300
Value in30090018003600
timezone?|

IANA time zone whose midnight starts today, such as Europe/Berlin. Without it the day starts at 00:00 UTC

Response Body

Successful Response

application/json
  1. response

The figures around the live floor, each block at its own window and cache.

meta*

Facts about the result

request*

The request as the server resolved it

traffic*array<>

Per page type over the window, busiest first

traffic_total*

The same counts over every page type of the window. A visitor seen on several page types counts once, so the rows do not sum to it

today*

Since 00:00 in the request's timezone, in UTC without it

performance*array<>

LCP per page type over the last 30 minutes

shares*array<>

Pageviews per page type over the last 60 minutes, busiest first

POST
/organizations/{org_id}/analytics/live-summary
curl -X POST 'https://api.fastmon.eu/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/analytics/live-summary' \  -H 'Content-Type: application/json' \  -d '{}'
{  "meta": {    "execution_time_ms": 0,    "total": 0,    "limit": 0,    "offset": 0,    "has_more": true,    "next_cursor": "string",    "sampling": {      "sampling_rate": 0,      "is_sampled": true,      "estimated_metrics": [        "string"      ]    },    "is_identity_mixed": true,    "next_poll_ms": 0  },  "request": {    "time_range": {      "from": "2019-08-24T14:15:22Z",      "to": "2019-08-24T14:15:22Z"    },    "comparison_time_range": {      "from": "2019-08-24T14:15:22Z",      "to": "2019-08-24T14:15:22Z"    },    "granularity": "minute",    "identity": "stitch",    "window_seconds": 0,    "filters": {}  },  "traffic": [    {      "pageviews": 0,      "visitors": 0,      "purchases": 0,      "bot_visitors": 0,      "page_type": "string",      "previous_period": {        "pageviews": 0,        "visitors": 0,        "purchases": 0,        "bot_visitors": 0      },      "previous_week": {        "pageviews": 0,        "visitors": 0,        "purchases": 0,        "bot_visitors": 0      }    }  ],  "traffic_total": {    "pageviews": 0,    "visitors": 0,    "purchases": 0,    "bot_visitors": 0,    "previous_period": {      "pageviews": 0,      "visitors": 0,      "purchases": 0,      "bot_visitors": 0    },    "previous_week": {      "pageviews": 0,      "visitors": 0,      "purchases": 0,      "bot_visitors": 0    }  },  "today": {    "visitors": 0,    "purchases": 0,    "bot_visitors": 0,    "sources": [      {        "referrer_source": "string",        "visitors": 0,        "share": 0      }    ],    "time_range": {      "from": "2019-08-24T14:15:22Z",      "to": "2019-08-24T14:15:22Z"    },    "previous_week": {      "visitors": 0,      "purchases": 0,      "time_range": {        "from": "2019-08-24T14:15:22Z",        "to": "2019-08-24T14:15:22Z"      },      "whole_day": {        "visitors": 0,        "purchases": 0,        "time_range": {          "from": "2019-08-24T14:15:22Z",          "to": "2019-08-24T14:15:22Z"        }      }    }  },  "performance": [    {      "page_type": "string",      "p75_lcp_ms": 0,      "sample_count": 0    }  ],  "shares": [    {      "page_type": "string",      "pageviews": 0,      "share": 0    }  ]}