Skip to main content

Analytics & Reporting

Measure what your Paylode program actually did — clicks, conversions, the earnings each conversion produced, how often your perk pages were viewed, and how your Boost campaigns performed — over your own data, on demand.

Analytics reach you two ways, built on the same layer:

  • In the Paylode app. The dashboards you see in the admin app — campaign performance, page activity — are built on this analytics layer. For most day-to-day questions, the app is the answer and needs nothing from you.
  • Directly, for your own dashboards. When you want the numbers inside your own BI tool or product, query the analytics API yourself. You ask a precise question ("how many conversions did I get per day last month?") and get back rows scoped to your account.

Built on Cube​

Paylode's analytics layer is Cube — an open semantic layer that exposes your data as named views, each with measures (the numbers: counts, sums) and dimensions (the attributes to slice by: date, campaign, status, your own cmeta tags). Because it's standard Cube, everything in Cube's own documentation about the REST query format applies here — Paylode adds the views, the account scoping, and the token handshake.

How the pieces fit​

There are two hosts and one short handshake:

  1. Mint a token. Trade your Paylode API key for a short-lived analytics token from recap.paylode.com. The token is scoped to your account.
  2. Query your metrics. Send that token to cube.paylode.com with a query describing the numbers you want. Results come back as rows — already filtered to your data, so there's no way to see another account's numbers.

The query format is the same across every metric. Once you can run one query, you can run all of them; the only thing that changes is which measures and dimensions you ask for. To see what's available to your account, call the /cubejs-api/v1/meta endpoint with your token — it lists every view, measure, and dimension your token can query. See Query your metrics.

Not real time​

Analytics are not real time — expect a data lag of roughly 6–12 hours between an event happening and it appearing in your queries. Numbers for the current day keep moving as data lands; treat yesterday as the freshest complete picture. Data freshness explains the timing in detail.

Start here​

  • Authenticate — trade your API key for an analytics token, and learn how the token is passed on to the query host.
  • Query your metrics — the query format (measures, dimensions, time ranges, filters) with a worked example, and the /meta discovery call.
  • Measure your perk pages — the views that carry perk-page activity and conversions.
  • Boost performance — measure the lift from each Boost campaign.
  • Data freshness — why today's numbers keep moving, and how recent the data is.

For the exact request and response schemas behind the token endpoint, see the API Reference.