fastmon Docs
Partners

Show every live client of the partner on one floor

Report an issue

One row per client organization with its traffic of the window, its LCP and its day.

A client is a row when it is active, approved and has an activated site on an active production application, also without visitors. data_total counts the listed clients together, recent_purchases lists the newest orders, and 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 window and the day of the partner floor.

filters?

Optional filters. Country, device and page type mean different things across shops and are refused

window_seconds?LiveWindow

Length of the window the traffic counts, which ends now. p75_lcp_ms and share 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

Every client of a partner on one floor, each with its own figures.

meta*

Facts about the result

request*

The request as the server resolved it

data*array<>

One row per live client organization, by organization_name and then organization_id, so a row keeps its place between polls

data_total*

The counts over the listed clients, the windows compared with included. The stitch is per site, so a visitor on two sites counts twice

recent_purchases*array<>

The newest order of each buyer of all clients in the window, newest first, at most 20, bots left out

POST
/organizations/{org_id}/partner/live
curl -X POST 'https://api.fastmon.eu/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/partner/live' \  -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,    "complete_until": "2019-08-24T14:15:22Z",    "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": {},    "url_param_key": "string"  },  "data": [    {      "pageviews": 0,      "visitors": 0,      "purchases": 0,      "bot_visitors": 0,      "cart_visitors": 0,      "checkout_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,        "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"            }          }        }      },      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",      "organization_name": "string",      "platform": {        "key": "string",        "label": "string"      },      "pageviews_per_second": 0,      "p75_lcp_ms": 0,      "sample_count": 0,      "share": 0,      "site_count": 0,      "is_stitchless": true,      "last_seen_at": "2019-08-24T14:15:22Z",      "sampling": {        "sampling_rate": 0,        "is_sampled": true,        "estimated_metrics": [          "string"        ]      }    }  ],  "data_total": {    "pageviews": 0,    "visitors": 0,    "purchases": 0,    "bot_visitors": 0,    "cart_visitors": 0,    "checkout_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,      "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"          }        }      }    },    "client_count": 0  },  "recent_purchases": [    {      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",      "received_at": "2019-08-24T14:15:22Z",      "device_type": "desktop",      "country": "string"    }  ]}