Count events per name, over time, as value sums, as orders and per prop value
The events of a window counted, the overview beside the row list.
events_by_name counts the most frequent names, series the events per
bucket with the same names broken out. value_sums sums the value prop
per event name and currency prop, where value reads as a number, and
names the funnel stage of each name. That is no revenue: a view_item
sums item prices. order_revenue is the money: per currency, one value per
pageview with an order_placed or purchase event, the largest of them.
Nothing is converted between currencies, and nothing checks that
currency is an ISO code. prop_keys lists the keys carried by the most events with their most
frequent values. Name one event in names to read its own props.
The stage events the collector derives from checkout pageviews are left
out, as the funnel counts those. Events are never sampled, so every number
is a count. The filters are the
ones of POST /analytics/events, and a filter without a column on the
events table is a 422.
bearerAuthAuthentifizierungBearer <fm_… / fmo_…>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.
org_id*Org Iduuidapplication/json- body
Request for the counts of the events of a window.
time_range*Time range, on the event's own timestamp
filters?Optional filters. Only the ones with a column on the events table are accepted: the site scope, stitch, the edge-derived dimensions and tracker_version. Anything else is a 422 naming it under its own path, because an empty answer would read as 'no events arrived'.
names?array<string>|Restrict to these event names, lowercased first. Null or omitted counts every name. Name one event to read the values of its own props.
granularity?GranularityRequestBucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets.
"auto""auto""minute""five_minutes""fifteen_minutes""hour""six_hours""day"timezone?|IANA time zone whose boundaries start the six_hours, day, week and month buckets, such as Europe/Berlin. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries
limit?LimitMax names in events_by_name, max keys in prop_keys and max values per key
1 <= value <= 10020Successful Response
application/json- response
The events of a window counted: per name, over time, as sums, as orders and per prop value.
Events are never sampled, so every number is a count.
meta*Facts about the result
request*The request as the server resolved it
event_count*Event CountEvents in the window
events_by_name*The limit most frequent event names to their events, most first
series*array<>One point per bucket with at least one event. A bucket with none is absent rather than zero-filled, as in /analytics/query.
value_sums*array<>Per event name and currency prop, the sum of the value prop over the events where it reads as a number, whatever the name means: a view_item sums item prices, not revenue. A convention, not a schema: nothing converts between currencies, and a name whose events carry no numeric value has no entry. Most events first
order_revenue*array<>Per currency prop, the money of the orders. An order is one pageview with a success-stage event, order_placed or purchase, and its value is the largest numeric value among them, so a pageview that sends both counts once. An event without a pageview is an order of its own, and a reloaded thank-you page is a second order. The collector's derived events and the Shopify pixel's carry no value and add nothing. names narrows it like every other figure. No conversion between currencies, most orders first
prop_keys*array<>The limit prop keys carried by the most events, most first
revenue*array<>DeprecatedDeprecated, use value_sums. It sums the value prop of every name, so it is no revenue: order_revenue is
curl -X POST 'https://api.fastmon.eu/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/analytics/events/overview' \ -H 'Content-Type: application/json' \ -d '{ "time_range": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z" }}'{ "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" }, "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" }, "event_count": 0, "events_by_name": { "property1": 0, "property2": 0 }, "series": [ { "timestamp": "2019-08-24T14:15:22Z", "event_count": 0, "events_by_name": { "property1": 0, "property2": 0 } } ], "value_sums": [ { "name": "string", "stage": "cart", "currency": "string", "value": 0, "event_count": 0 } ], "order_revenue": [ { "currency": "string", "value": 0, "order_count": 0 } ], "prop_keys": [ { "key": "string", "event_count": 0, "events_by_value": { "property1": 0, "property2": 0 } } ], "revenue": [ { "name": "string", "stage": "cart", "currency": "string", "value": 0, "event_count": 0 } ]}