Skip to content
Coritan Docs

Read your organization's overview

See what needs attention, this month's figures, the first steps and today's storefront visitors for an organization, and open the staff console's tools.

View as Markdown

The Overview opens when you select an organization. It shows what needs your attention, this month's figures, the first steps for a new organization, the visits to your storefront today and who has it open now, and what changed recently. It also links to the tools your team uses in the staff console.

Every member can open the Overview, and each sees what their role can act on. The money figures, and the invoices, disputes, refunds, payouts and PayNow under Needs attention, need the owner, admin or billing role; a member without one sees a line under the figures that says so and names the owner to ask. The pause on new orders is for every member. Getting started, Recent activity, and the plan limits, the domain and the store under Needs attention, need the owner or admin role.

Needs attention appears at the top when something needs doing, most urgent first. Each item has a button to the page that settles it:

Item Button
Invoices are overdue, with what is still owed on them. Review invoices
Disputes are open, with the date evidence is due. Coritan prepares and submits the evidence. Review disputes
Refund requests are waiting for a decision, with when the oldest arrived. Review requests
New orders are paused, because your monthly usage budget is reached or an invoice for usage is unpaid. It names the reason, and servers that already run keep running. Every member sees it. See usage and cost, or See the details for a member without the billing role
Your usage is at 80% or more of your monthly budget. See usage and cost
Coritan collects your customers' payments and has no PayPal address or Stripe account to send your payouts to, so each payout waits for Coritan to pay it by hand. Open a ticket
Customer accounts, services or products have reached 80% of what your plan allows, or all of it. Ask to raise it, which opens a support ticket
Your storefront's domain is not verified, or does not serve your storefront yet. It does once it is verified and Coritan has added it for your organization. Check domain, which opens Settings, then Storefront
Your customers pay into your own PayNow store and it is not connected. Connect PayNow
Your store is in test mode. Open the merchant profile, or Open a ticket once the merchant profile is approved

When the page could not check one of these, the card says what it could not check, with Try again.

Revenue this month
Your store sales and your hosting money so far this month, together: the revenue your platform cut is counted on, in your organization's default currency at the day's market rate. When no rate converts US dollars to that currency, the figure stays in US dollars. The line under it splits store and hosting, and reads All from hosting when your organization has no store.
Platform cut
What the cut comes to so far this month, at the rate the month's revenue pays. Coritan's own organizations pay none and read None.
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. Under each, how many there are in all and how many your plan allows, such as 6 in all, of 100 allowed, with a bar that fills as you near the limit.

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

Owners and admins see Getting started until every step is done:

  • Give the storefront its own domain. Once it has one, the step asks you to verify it, such as Verify portal.example.com, and it is ticked when the domain is Verified.
  • Add the brand's logo and colours.
  • Create a first product.
  • Tell Coritan where to send payouts, when Coritan collects your customers' payments. It is ticked once Coritan has a PayPal address or a Stripe account for them.
  • Connect PayNow, when your customers pay into your own PayNow store.
  • Add a member.

Each open step goes to the page where you do it, and a step is ticked as soon as your organization has what it asks for. To hide the list in this browser, select Hide these steps, the cross in its corner.

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. All traffic opens Traffic, with the visits, top pages and conversions over a longer range.

Live now shows the visitors with your storefront open, counted until 5 minutes after their last tab closes, 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 from Traffic to its pages.

Owners and admins see Recent activity: the latest changes in the organization, each with who made it and what it changed. A change names the member who made it, or reads You for your own, and the record it changed, linked to its page: a member by name, a service by its hostname, an invoice by its number, a customer by their email. A record the change did not name is a link such as Open the customer. All activity opens the audit log.

Your team answers tickets, runs servers and handles refunds, coupons and the forum in the staff console, on your storefront's domain. The Staff console card links to its Tickets, Servers, Refunds, Coupons and Moderation pages, each in a new tab.

The staff console needs a domain for your storefront, verified and serving your storefront (Set your custom domain). Until then the card says so, and no page links to the staff console. The header of every organization page shows the domain as plain text: Not verified beside it until it is verified, when owners and admins also see Check domain there, and Not served while Coritan does not serve your storefront on it yet. With no domain at all, owners and admins see Set a domain, which opens Settings, then Storefront.

The money figures are missing
Your role does not include billing, and the line under the figures names the owner. Ask the owner or an admin for the billing role if you need the figures.
Revenue this month is lower than the invoices paid this month
It counts store sales and hosting money as the platform cut's Revenue in the month does, in US dollars, and converts the total at the day's market rate. Invoices marked paid, and invoices paid from credit you granted, are not money a customer paid, so they are not in it.
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 figures and Needs attention come from one route, which any member may call:

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

Every member's answer has customers and services (active and all, against the plan's limit), products, storefront (custom_domain, domain_verified, logo and colours_chosen) and store (status, test_mode and can_go_live, or null without a store). Tier 3 support and above also get refunds (waiting and oldest_at). The owner, admin and billing roles also get overdue, outstanding (one row per currency still owed), disputes (open and the soonest evidence_due_at), payout (method, and whether a destination is set and needed), paynow when customers pay into your own PayNow store, revenue (this month so far, in your currency, with the exchange_rate) and cut (cut_usd, rate_percent and exempt). A part your role may not read is left out of the answer.

The revenue statistics take the owner, admin or billing role:

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. The platform cut for each month is on GET /api/v1/orgs/acme/billing/cut.

The traffic routes behind the two cards take any member:

Operation What it returns
GET /api/v1/orgs/acme/tracking/live The visitors with the storefront open, counted until 5 minutes after their last tab closes: 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. Add tz (an IANA zone name such as America/New_York) to count since that zone's midnight.

The routes for a range of days and the tracking script are on Read your storefront's traffic.

API operations on this page

MethodPathWhat it does
GET/api/v1/orgs/{org_slug}/summaryThe Overview's figures and what needs attention, in one answer
GET/api/v1/orgs/{org_slug}/stats/revenueThe same figures the admin console shows for this organization
GET/api/v1/orgs/{org_slug}/tracking/liveThe visitors on the organization's storefront right now
GET/api/v1/orgs/{org_slug}/tracking/todayOrg tracking today