Report Top Performers
GET /reports/top-performers
Most (or least) moved items
Scope reports:read; needs the Reports app.
Request
GET https://example.com/api/index.php/v1/nextinventory/reports/top-performers?limit=<integer>&days=<integer>&type=<string>Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
limit |
integer |
query |
No | Defaults to 10. |
days |
integer |
query |
No | Defaults to 30. |
type |
string |
query |
No | One of best, worst. Defaults to best. |
Responses
200 — The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.
{
"data": "string"
}| Field | Type | Meaning |
|---|---|---|
data |
object |
Errors
| Status | Code | When |
|---|---|---|
4 |
A refusal. Common codes: MISSING_TOKEN / INVALID_TOKEN (401); API_DISABLED, ACCOUNT_UNUSABLE, ACCESS_DENIED, TASK_NOT_ALLOWED, MISSING_SCOPE, APP_DISABLED, DEMO_LOCKED, FORBIDDEN (403); NOT_FOUND (404); BAD_REQUEST / INVALID_JSON / INVALID_IDEMPOTENCY_KEY (400, validation and stock rules, with the reason in title); IDEMPOTENCY_IN_PROGRESS (409); PRECONDITION_FAILED (412, the record changed since the If-Match ETag was read); IDEMPOTENCY_KEY_REUSED (422); RATE_LIMITED / TOO_MANY_FAILED_LOGINS (429, with a Retry-After header in seconds); SERVER_ERROR (500). |
Examples
curl
curl -s "https://example.com/api/index.php/v1/nextinventory/reports/top-performers" \
-H "Authorization: Bearer $API_TOKEN"PHP
<?php
$ch = curl_init('https://example.com/api/index.php/v1/nextinventory/reports/top-performers?limit=<integer>&days=<integer>&type=<string>');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('API_TOKEN'),
],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);JavaScript
const API_TOKEN = process.env.API_TOKEN;
const response = await fetch("https://example.com/api/index.php/v1/nextinventory/reports/top-performers?limit=<integer>&days=<integer>&type=<string>", {
headers: {
"Authorization": `Bearer ${API_TOKEN}`,
},
});
const data = await response.json();