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/issues

Parameters

NameInTypeRequiredWhat it is
AuthorizationheaderstringYesBearer, a space, then the key.
Idempotency-KeyheaderstringNoAny 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.

FieldTypeRequiredWhat it is
messagestringYesWhat went wrong, in full sentences.
pagestringNoThe 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."
}'

Response

201: Created. The answer is what was made, as JSON.

FieldTypeAlways thereWhat it is
idintegerYesThe report's id.
duplicatebooleanYesTrue 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.

StatusCodeWhenWhat to do
400api.invalidA 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.
400bad_request.saidChange it and try again.
401api.key_missingThe call had no Authorization header.Send the key in the Authorization header as Bearer, then call again.
401api.key_refusedThe 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.
401api.wrong_key_kindThis key does not open these endpoints.Use the key these endpoints were made for, or ask the person who gave you the key.
403refusedThe 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.
403auth.not_freshThis step needs you to prove it is you.Confirm your password or passkey, then try again.
403refused.demoThe key belongs to a shared demo account, which may not change anything.Use a key made in a real company account.
409api.idempotency_conflictThat Idempotency-Key was sent before with a different request.Send a new key with a new request, or send the first request again unchanged.
409api.idempotency_busyThe first request with that Idempotency-Key is still running.Wait a few seconds, then send it again.
429api.rate_limitedThe key made more than 120 calls in this minute. Wait the seconds in Retry-After.Wait the seconds in Retry-After, then call again.
429limit.saidWait for the next hour, or ask us to raise it.
500serverSomething failed on our side. The answer carries a requestId to quote.Try again in a minute; if it keeps happening, report it.
503developer.unavailableAPI keys are not set up on this deployment yet.Report it, and we will switch them on.