Skip to content

fix: performance API docs status codes, period default, example dates; dashboard trend from zero #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sonpiaz merged 2 commits into from
Oct 17, 2026
Merged

fix: performance API docs status codes, period default, example dates; dashboard trend from zero #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c16c7d6
fix: performance API docs status codes, period default, example dates…
sonpiaz Oct 17, 2026
ff0817e
fix: view-performance metric cards, chart trend badge and period menu…
sonpiaz Oct 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions content/docs/api-reference/performance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Requests must be authenticated. The authenticated user must be an active workspa
|--------|-------|
| `Authorization` | Session token (Affitor dashboard session) |

An unauthenticated request and a request from a user who is not a workspace member of the program both return `403`.
An unauthenticated request, a request from a user who is not an active workspace member of the program, and a request for a program that does not exist all return `403`.

:::note

Expand Down Expand Up @@ -61,8 +61,8 @@ HTTP `200` with the following shape:
{
"data": [
{
"date": "2024-06-01",
"period": "2024-06-01",
"date": "2024-05-31",
"period": "2024-05-31",
"clicks": 42,
"leads": 5,
"conversions": 2,
Expand All @@ -72,8 +72,8 @@ HTTP `200` with the following shape:
"commission": 20.00
},
{
"date": "2024-06-02",
"period": "2024-06-02",
"date": "2024-06-01",
"period": "2024-06-01",
"clicks": 18,
"leads": 2,
"conversions": 0,
Expand Down Expand Up @@ -166,7 +166,7 @@ Growth from nothing has no percentage. When the previous period value is `0` and

| Field | Type | Description |
|-------|------|-------------|
| `period` | string | The `period` query param value used (or `"all"` for default) |
| `period` | string | The `period` query param value used (`"7d"` when none is sent) |
| `dateFrom` | string (ISO 8601) | Actual start of the current period used in the query |
| `dateTo` | string (ISO 8601) | Actual end of the current period used in the query |
| `previousPeriod.dateFrom` | string (ISO 8601) | Start of the comparison period |
Expand All @@ -178,7 +178,5 @@ Growth from nothing has no percentage. When the previous period value is `0` and

| Status | When |
|--------|------|
| `401 Unauthorized` | No authenticated session |
| `403 Forbidden` | Authenticated user is not an active workspace member of `programId` |
| `404 Not Found` | Program with the given `programId` does not exist |
| `403 Forbidden` | No signed-in session, the user is not an active workspace member of `programId`, or the program does not exist |
| `500 Internal Server Error` | Unexpected server error |
16 changes: 7 additions & 9 deletions content/docs/brand/quickstart/view-performance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: View Performance
description: Monitor your affiliate program metrics and partner results
kind: guide
last_updated: 2026-10-15
last_updated: 2026-10-16
---

Monitor program-wide metrics, identify top-performing partners, and spot issues before they impact revenue.
Expand All @@ -17,16 +17,15 @@ Your dashboard shows program-wide metrics at a glance:

| Metric | Description |
|--------|-------------|
| **Partners** | Total active partners in your program |
| **Clicks** | Total visits from affiliate links |
| **Signups** | Leads captured (registrations, form submissions) |
| **Paid Customers** | Conversions that generated revenue |
| **Revenue** | Total sales from affiliate traffic |
| **Commission Payout** | Total commissions paid to partners |
| **Partners** | Partners who joined your program in the period |
| **Clicks** | Visits from affiliate links |
| **Sign Ups** | Leads captured (registrations, form submissions) |
| **Paid Customers** | Conversions that generated revenue |

Each metric shows percentage change compared to the previous period.
The chart below shows the selected metric's percentage change compared to the previous period. It shows no percentage when the metric did not change, or when it was 0 in the previous period, since growth from nothing has none.

Use the date picker to filter by: Last 7 days, Last 30 days, or custom range.
Use the period menu to pick **Last 7 Days**, **Last 30 Days**, **Last 90 Days** or **All Time**.

---

Expand Down Expand Up @@ -90,7 +89,6 @@ Use date comparisons to spot trends:

- **Week over week** – Short-term momentum
- **Month over month** – Growth patterns
- **Custom range** – Campaign-specific analysis

Look for:
- Which partners are growing vs. declining
Expand Down
Loading