Skip to content
Coritan Docs

Organization API: Org Staff Live

Every Organization API operation tagged Org Staff Live.

View as Markdown

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

Method Path Summary
GET /api/v1/orgs/{org_slug}/staff/live What is happening on the storefront right now, for the staff Live page

What is happening on the storefront right now, for the staff Live page

Section titled What is happening on the storefront right now, for the staff Live page

GET /api/v1/orgs/{org_slug}/staff/live

What is happening on the storefront right now, for the staff Live page.

Any member of the brand's support staff (Tier 1 and above) may read it; read-only members are refused. It answers:

  • visitors_now: the visitors active in the last 5 minutes, bots left out, each person counted once. sessions_today is the visits since the brand's day began, in the brand's own time zone.
  • orders_today and revenue_today: the orders placed and the money paid in since the brand's day began. revenue_today is in currency, the one with the most money today. Money in another currency is never added in. These two and recent_orders can be up to 10 seconds old.
  • stages: how many visitors are browsing, in the cart, at checkout or purchased, read from the page each one is on.
  • visitors: those visitors we could place on the map, at most 500: id (an opaque id that is stable for the visit), lat, lon, country (a two-letter code), city, page (the path), stage, source (where the visit came from, worded as in sources, such as Direct or Google) and since (when the visit began). A visitor with no place is left off the map and counted everywhere else. No address or email is answered.
  • top_pages, sources and devices: the most visited pages, the sources visits came from and the devices they use, as {path|source|device, visitors}.
  • recent_orders: the last 8 orders that were paid for, newest first: id, number (the invoice number), customer, product, amount, currency and created_at.
  • players_online and busiest_servers: the players connected to the brand's servers and the five servers with the most, as {uuid, name, players, node_name}. Only Tier 2 support and above see them; below that players_online is null and busiest_servers empty. They are also null and empty when the game proxies cannot vouch for a count.

Every figure covers this brand only.

Name In Type Required
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.