Skip to content
Coritan Docs

Read your organization's overview

See revenue, customers, services and storefront visitors for an organization, and add the visitor tracking script to your site.

View as Markdown

The Overview tab opens when you select an organization. It shows what your customers have paid and still owe, who is on your storefront today and right now, what your plan allows and what changed recently.

Every member can open the tab. The revenue figures need the owner, admin or billing role, and Recent activity needs the owner or admin role. Other members see links to the other tabs in its place.

Revenue collected
What your customers paid through the payment gateways, Coritan's and your own PayNow store's, plus the money they added to their account credit, less refunds and chargebacks. It counts from the day the organization began. Invoices marked paid and invoices paid from credit you granted are not in it, because nobody was charged.
Outstanding
The total of your unpaid and overdue invoices. When customers owe money in more than one currency, the other currencies follow under the figure.
Active customers and Active services
How many of each are active, against the number your plan allows.

For a period's figures with the gateway fees taken off, generate a statement.

Storefront today counts the visits to your storefront since midnight UTC: Sessions, Unique visitors, Page views, visits by customers who were Signed in, the Average visit length and the Bounce rate. Select the refresh button in the card to update it.

Live now shows the visitors on your storefront this minute, split into Signed in and Guests, and the Busiest pages they are on.

When your storefront runs on Coritan, its visits count automatically. To count the visits to another site of yours, add the tracking script to its pages (see With the API).

Plan limits lists how many Customers, Services, Custom products and Sub-resellers your plan allows, and its API calls per month. Coritan sets the plan. Contact support to change it.

"Only owners, admins and billing members see revenue figures."
Your role does not include billing. Ask the owner or an admin for the billing role if you need the figures.
Revenue collected is lower than your paid invoices
Invoices marked paid, and invoices paid from credit you granted, do not count as revenue.
The traffic cards stay at zero
No visitor has reached a page that carries the tracking script. A storefront on your own server needs the script added.

The revenue figures take the owner, admin or billing role; the traffic routes take any member.

Shell
curl "https://api.coritan.com/api/v1/orgs/acme/stats/revenue" \
  -H "Authorization: Bearer $CORITAN_TOKEN"

The answer has total_revenue, the parts it is made of (gateway_payments, wallet_topups, refunded, charged_back and own_store_collected), the paid invoice value it leaves out (settled_with_credit and marked_paid), outstanding_by_currency (one currency and amount pair for each currency still owed), active_customers and active_services.

Get the tracking script for a site that does not run on Coritan:

Shell
curl "https://api.coritan.com/api/v1/orgs/acme/tracking/script" \
  -H "Authorization: Bearer $CORITAN_TOKEN"

The answer's snippet is a <script> tag. Paste it before </body> on every page of the site. The site must use HTTPS. The script counts page views, referrers and devices, and follows navigation in single-page apps.

The traffic routes:

Operation What it returns
GET /api/v1/orgs/acme/tracking/live The visitors active now: total_active, authenticated_active, guest_active, sessions and active_pages.
GET /api/v1/orgs/acme/tracking/today Today's figures since midnight UTC, as on the Storefront today card.
GET /api/v1/orgs/acme/tracking/stats One row for each period between start_date and end_date (both YYYY-MM-DD). granularity is hourly, daily (the default), weekly or monthly.
GET /api/v1/orgs/acme/tracking/pages The most viewed pages between start_date and end_date, with views, unique_views and avg_time_seconds. page and per_page (50 by default, at most 100) page through them.
GET /api/v1/orgs/acme/tracking/conversions How many visitors became customers between start_date and end_date, the conversion rate, and the average days, sessions and pages it took.
Shell
curl "https://api.coritan.com/api/v1/orgs/acme/tracking/stats?start_date=2026-08-01&end_date=2026-08-31&granularity=weekly" \
  -H "Authorization: Bearer $CORITAN_TOKEN"

API operations on this page

MethodPathWhat it does
GET/api/v1/orgs/{org_slug}/stats/revenueThe same figures the admin console shows for this organization
GET/api/v1/orgs/{org_slug}/tracking/liveOrg tracking live
GET/api/v1/orgs/{org_slug}/tracking/todayOrg tracking today
GET/api/v1/orgs/{org_slug}/tracking/statsOrg tracking stats
GET/api/v1/orgs/{org_slug}/tracking/pagesOrg tracking pages
GET/api/v1/orgs/{org_slug}/tracking/conversionsOrg tracking conversions
GET/api/v1/orgs/{org_slug}/tracking/scriptOrg tracking script