Proteside Docs
Endpoint referencePCI reports

PCI report for a period (JSON, PDF or CSV)

GET
/reports/pci

Reuses the most recent snapshot for exactly the same period; otherwise generates an on_demand snapshot. format=pdf answers 302 Location: <signed URL, 1 h> (or the PDF bytes when the file is not in storage yet); format=csv streams the chosen table. regenerate=true forces a new snapshot and requires reports:generate. Non-partner organizations need a plan with compliance reports (403 plan_limit).

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.

Query Parameters

org_id?string

Partners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.

Formatuuid
store_id*string
Formatuuid
period_start?string

Default: period_end − 7 days

Formatdate-time
period_end?string

Default: now. Max range 366 days.

Formatdate-time
format?string
Default"json"
Value in"json""pdf""csv"
csv_table?string
Default"scripts"
Value in"scripts""headers""alerts"
locale?string
Default"pt-BR"
Value in"pt-BR""en"
regenerate?boolean
Defaultfalse

Response Body

Snapshot (json) or CSV

  1. response
id?string
Formatuuid
store_id?string
Formatuuid
kind?string
Value in"weekly""on_demand""monthly"
period_start?string
Formatdate-time
period_end?string
Formatdate-time
locale?string
Value in"pt-BR""en"
schema_version?integer
sha256?string|null
generated_by?string
has_pdf?boolean
csv_tables?array<string>
created_at?string
Formatdate-time
generated?boolean

true when this request generated the snapshot

data?

Report data schema_version 2: meta, scope, summary_643, summary_1161, scripts[], headers[], alerts[], policies[], periodic_checks[], data_access[]

curl -X GET "https://example.com/reports/pci?store_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "f1a2b3c4-9999-4000-8111-222233334444",  "store_id": "0c1d2e3f-1111-4222-8333-444455556666",  "kind": "on_demand",  "period_start": "2026-09-20T10:00:00.000Z",  "period_end": "2026-09-27T10:00:00.000Z",  "locale": "pt-BR",  "schema_version": 2,  "sha256": "9c1e…",  "generated_by": "api:ps_live_AbCdEfGhIjKlMnOpQrStUvWx",  "has_pdf": true,  "csv_tables": [    "scripts",    "headers",    "alerts"  ],  "created_at": "2026-09-27T10:12:00.000Z",  "generated": true,  "data": {    "meta": {      "report_id": "f1a2b3c4-…",      "store": "Loja do João",      "domain": "lojadojoao.com.br",      "schema_version": 2    },    "summary_643": {      "total": 21,      "authorized": 18,      "blocked": 1,      "needs_review": 2,      "expired": 0    },    "summary_1161": {      "events": 91234,      "alerts_total": 12,      "alerts_open": 1    },    "scripts": [],    "headers": [],    "alerts": [],    "policies": [],    "periodic_checks": [],    "data_access": []  }}

Remove a store's report schedule DELETE

Previous Page

A specific snapshot (JSON, PDF or CSV) GET

Next Page