Appearance
Administration API
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
GET /geoip
The visitor-location providers, in the order they are asked (installation administrators)
headers (Cloudflare / nginx proxy headers, on by default), maxmind (GeoLite2 City database: account_id + license_key), dbip (DB-IP City Lite database, no account), ipinfo (web API: token; sends visitor addresses to IPinfo). The first that knows a field wins; later ones only fill in what is missing. Secrets are never returned: license_key / token say whether one is set. Databases show whether the file is there and when it was built.
Responses
- 200 — Providers.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].provider | string | One of: headers, maxmind, dbip, ipinfo. | |
data[].enabled | boolean | ||
data[].account_id | string, nullable | ||
data[].license_key | boolean | Whether a licence key is set. | |
data[].token | boolean | Whether a token is set. | |
data[].installed | boolean | Databases: whether the file is there. | |
data[].downloaded_at | string (date-time), nullable | ||
data[].built_at | string (date-time), nullable | ||
data[].error | string, nullable | The last download's failure. |
bash
curl -X GET "https://your-site.com/api/v1/geoip" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /geoip/{provider}
Switch a location provider on or off and save its credentials (switching a database on downloads it)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes | One of: headers, maxmind, dbip, ipinfo. |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | ||
account_id | string, nullable | MaxMind only. | |
license_key | string, nullable | MaxMind only. | |
token | string, nullable | IPinfo only. |
Responses
- 200 — The provider.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.provider | string | One of: headers, maxmind, dbip, ipinfo. | |
data.enabled | boolean | ||
data.account_id | string, nullable | ||
data.license_key | boolean | Whether a licence key is set. | |
data.token | boolean | Whether a token is set. | |
data.installed | boolean | Databases: whether the file is there. | |
data.downloaded_at | string (date-time), nullable | ||
data.built_at | string (date-time), nullable | ||
data.error | string, nullable | The last download's failure. |
bash
curl -X PUT "https://your-site.com/api/v1/geoip/{provider}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"enabled":true,"account_id":"text","license_key":"text","token":"text"}'POST /geoip/{provider}/download
Download a location database now (also done weekly for the ones that are on)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes | One of: maxmind, dbip. |
Responses
- 200 — The provider.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — The download failed (the message says why).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.provider | string | One of: headers, maxmind, dbip, ipinfo. | |
data.enabled | boolean | ||
data.account_id | string, nullable | ||
data.license_key | boolean | Whether a licence key is set. | |
data.token | boolean | Whether a token is set. | |
data.installed | boolean | Databases: whether the file is there. | |
data.downloaded_at | string (date-time), nullable | ||
data.built_at | string (date-time), nullable | ||
data.error | string, nullable | The last download's failure. |
bash
curl -X POST "https://your-site.com/api/v1/geoip/{provider}/download" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /translations/{locale}
The texts administrators changed in a language (public)
Source text (English) => the text shown instead of the shipped translation. The dashboard loads them over its own translations; the server applies them itself.
No sign-in needed
This endpoint is public.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
locale | path | string | yes | Pattern ^[a-z]{2}$. |
Responses
- 200 — The changed texts.
- 404 — Missing, or another account's.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object |
bash
curl -X GET "https://your-site.com/api/v1/translations/{locale}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /admin/translations
Every text of the product in a language (administrators)
The dashboard's, the website's and the server's texts (emails, messages), 50 per page, by their English source text, with the shipped translation and the administrators' own wording (null: none).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
locale | query | string | yes | |
q | query | string | Matches the source text, the translation or the changed text. At most 200 characters. | |
area | query | string | One of: dashboard, website, server. | |
changed | query | boolean | Only the changed texts. | |
page | query | integer | Minimum 1. |
Responses
- 200 — The texts.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].key | string | ||
data[].translation | string | ||
data[].value | string, nullable | ||
data[].areas | string[] | ||
meta | object | ||
meta.page | integer | ||
meta.total | integer | ||
meta.last_page | integer | ||
meta.changed | integer | ||
meta.locales | string[] |
bash
curl -X GET "https://your-site.com/api/v1/admin/translations" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /admin/translations
Change a text in a language (administrators)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
locale | string | yes | |
key | string | yes | The English source text. |
value | string, nullable | yes | The text to show; empty or null: back to the shipped translation. |
Responses
- 200 — data:
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — The text isn't used in the product.
- 422 —
bash
curl -X PUT "https://your-site.com/api/v1/admin/translations" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"locale":"text","key":"text","value":"text"}'GET /admin/overview
The installation at a glance (administrators)
Headline numbers (with the period before), daily series, breakdowns and lists from the core and every installed module, each in a section (revenue, growth, usage), for the last 7, 30 or 90 days in the administrator's time zone.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
days | query | integer | One of: 7, 30, 90. Default 30. |
Responses
- 200 —
dataholdsstats,series,breakdownsandlists;metathe period (days,from,to,timezone). - 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.stats | object[] | ||
data.series | object[] | ||
data.breakdowns | object[] | ||
data.lists | object[] | ||
meta | object |
bash
curl -X GET "https://your-site.com/api/v1/admin/overview" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /admin/overview/export
The Overview as CSV (administrators; 10 per minute)
One row per figure: section, part (stat, daily, breakdown, list), label, item (date, row or currency), value, previous_period, note.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
days | query | integer | One of: 7, 30, 90. Default 30. |
Responses
- 200 — CSV (text/csv).
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X GET "https://your-site.com/api/v1/admin/overview/export" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /users/export
Every matching user as CSV, with the modules' columns (administrators; 10 per minute)
Takes the same filters and order as GET /users (search, role, status, via, sort), without pages.
Responses
- 200 — CSV (text/csv).
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X GET "https://your-site.com/api/v1/users/export" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /users
Every account that can sign in (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | integer | Minimum 1. Default 1. | |
per_page | query | integer | Minimum 1. Maximum 100. Default 25. | |
search | query | string | Name or email contains. | |
role | query | string | One of: admin, user. | |
status | query | string | One of: active, suspended, never. | |
via | query | string | One of: install, invite, signup. | |
sort | query | string | One of: -created_at, created_at, -last_login_at, name, email. |
Responses
- 200 — Users with module columns (
meta.columns, values in each user'sfacts) and totals. - 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].name | string | ||
data[].email | string | ||
data[].is_admin | boolean | ||
data[].suspended | boolean | ||
data[].suspended_at | string (date-time), nullable | ||
data[].two_factor | boolean | Two-factor sign-in is on. | |
data[].signed_up_via | string | One of: install, invite, signup. | |
data[].organization | object, nullable | ||
data[].organization.id | integer | ||
data[].organization.name | string | ||
data[].last_login_at | string (date-time), nullable | ||
data[].created_at | string (date-time) | ||
data[].facts | object | Module columns (see meta.columns). | |
meta | object | ||
meta.current_page | integer | ||
meta.last_page | integer | ||
meta.per_page | integer | ||
meta.total | integer | ||
meta.columns | object | ||
meta.totals | object | ||
meta.totals.users | integer | ||
meta.totals.new_30_days | integer | ||
meta.totals.admins | integer | ||
meta.totals.suspended | integer |
bash
curl -X GET "https://your-site.com/api/v1/users" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /users/{user}
Change the role or suspend (never one's own account)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user | path | integer | yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
is_admin | boolean | ||
suspended | boolean | A suspension signs the person out everywhere. | |
two_factor | boolean | Only false: turns off the person's two-factor sign-in (lost phone and recovery codes). One of: false. |
Responses
- 200 — The user.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — Validation failed.
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object | ||
data.id | integer | ||
data.name | string | ||
data.email | string | ||
data.is_admin | boolean | ||
data.suspended | boolean | ||
data.suspended_at | string (date-time), nullable | ||
data.two_factor | boolean | Two-factor sign-in is on. | |
data.signed_up_via | string | One of: install, invite, signup. | |
data.organization | object, nullable | ||
data.organization.id | integer | ||
data.organization.name | string | ||
data.last_login_at | string (date-time), nullable | ||
data.created_at | string (date-time) | ||
data.facts | object | Module columns (see meta.columns). |
bash
curl -X PATCH "https://your-site.com/api/v1/users/{user}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"is_admin":true,"suspended":true,"two_factor":false}'DELETE /users/{user}
Remove a user (and their account with all its data when they were its last member)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user | path | integer | yes |
Responses
- 204 — Removed.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — Your own account.
bash
curl -X DELETE "https://your-site.com/api/v1/users/{user}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /invitations
Pending invitations
Responses
- 200 — Invitations, newest first.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
Response fields
| Field | Type | Required | Description |
|---|---|---|---|
data | object[] | ||
data[].id | integer | ||
data[].email | string | ||
data[].is_admin | boolean | ||
data[].organization | string, nullable | The account they join; null = a new account. | |
data[].invited_by | string, nullable | ||
data[].created_at | string (date-time) | ||
data[].expires_at | string (date-time) |
bash
curl -X GET "https://your-site.com/api/v1/invitations" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /invitations
Invite someone by email (the link works once, for 7 days)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | |
account | string | yes | Join the inviter's account, or get a new one. One of: team, new. |
is_admin | boolean |
Responses
- 201 — Sent.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — Validation failed.
bash
curl -X POST "https://your-site.com/api/v1/invitations" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"email":"[email protected]","account":"team","is_admin":true}'DELETE /invitations/{invitation}
Revoke an invitation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
invitation | path | integer | yes |
Responses
- 204 — Revoked.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X DELETE "https://your-site.com/api/v1/invitations/{invitation}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"