Notifications and issues
POST/v1/issues
Report a problem with Panlytics to the Panlytics team, as the app's Report a problem box does.
What it does
Text only: no screenshot or recording. It is filed under the person who made the key and marked as sent with a key. Send an Idempotency-Key header so a retry never files it twice.
Who may call it
Any live key may call it. It reads only what the key's maker may already see about themselves.
Request
HTTP
POST https://panlytics.net/api/v1/issuesParameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
Authorization | header | string | Yes | Bearer, a space, then the key. |
Idempotency-Key | header | string | No | Any string up to 255 characters, new for each new request. The same key with the same request within 24 hours answers with the first answer again and does nothing twice. |
Body
Sent as application/json.
| Field | Type | Required | What it is |
|---|---|---|---|
message | string | Yes | What went wrong, in full sentences. |
page | string | No | The app page it happened on, if you know it, such as /category/40/actions. |
Example request
curl -X POST https://panlytics.net/api/v1/issues \
-H "Authorization: Bearer $PANLYTICS_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"message": "The order list shows no products for Dairy since this morning."
}'import os
import uuid
import requests
response = requests.post(
"https://panlytics.net/api/v1/issues",
headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"message": "The order list shows no products for Dairy since this morning."
},
timeout=60,
)
response.raise_for_status()
print(response.json())const response = await fetch("https://panlytics.net/api/v1/issues", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"message": "The order list shows no products for Dairy since this morning."
}),
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());Response
201: Created. The answer is what was made, as JSON.
| Field | Type | Always there | What it is |
|---|---|---|---|
id | integer | Yes | The report's id. |
duplicate | boolean | Yes | True when the same report had already been filed. |
Example response
201
{
"id": 88,
"duplicate": false
}Errors
A refusal is JSON with a code, a sentence in error, and a requestId when the fault is ours. Read the code, not the sentence. Every code is listed on Errors.
| Status | Code | When | What to do |
|---|---|---|---|
| 400 | api.invalid | A path id, a query parameter, a header or a body field is missing or not valid. detail names the field. | Read that endpoint in the API reference, correct the field and call again. |
| 400 | bad_request.said | Change it and try again. | |
| 401 | api.key_missing | The call had no Authorization header. | Send the key in the Authorization header as Bearer, then call again. |
| 401 | api.key_refused | The key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability). | Ask the person who gave you the key to make a new one. |
| 401 | api.wrong_key_kind | This key does not open these endpoints. | Use the key these endpoints were made for, or ask the person who gave you the key. |
| 403 | refused | The key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach. | Ask the CEO for a role that allows it, or call it for a shop or category the role reaches. |
| 403 | auth.not_fresh | This step needs you to prove it is you. | Confirm your password or passkey, then try again. |
| 403 | refused.demo | The key belongs to a shared demo account, which may not change anything. | Use a key made in a real company account. |
| 409 | api.idempotency_conflict | That Idempotency-Key was sent before with a different request. | Send a new key with a new request, or send the first request again unchanged. |
| 409 | api.idempotency_busy | The first request with that Idempotency-Key is still running. | Wait a few seconds, then send it again. |
| 429 | api.rate_limited | The key made more than 120 calls in this minute. Wait the seconds in Retry-After. | Wait the seconds in Retry-After, then call again. |
| 429 | limit.said | Wait for the next hour, or ask us to raise it. | |
| 500 | server | Something failed on our side. The answer carries a requestId to quote. | Try again in a minute; if it keeps happening, report it. |
| 503 | developer.unavailable | API keys are not set up on this deployment yet. | Report it, and we will switch them on. |