Proteside Endpoint referencePCI reports
A specific snapshot (JSON, PDF or CSV)
GET
bearerAuthheader
AuthorizationBearer <token>API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.
id*stringFormat
uuidorg_id?stringPartners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.
Format
uuidformat?stringDefault
"json"Value in
"json""pdf""csv"csv_table?stringDefault
"scripts"Value in
"scripts""headers""alerts"Snapshot with data
- response
id?stringFormat
uuidstore_id?stringFormat
uuidkind?stringValue in
"weekly""on_demand""monthly"period_start?stringFormat
date-timeperiod_end?stringFormat
date-timelocale?stringValue in
"pt-BR""en"schema_version?integersha256?string|nullgenerated_by?stringhas_pdf?booleancsv_tables?array<string>created_at?stringFormat
date-timegenerated?booleantrue 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/snapshots/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0", "kind": "weekly", "period_start": "2019-08-24T14:15:22Z", "period_end": "2019-08-24T14:15:22Z", "locale": "pt-BR", "schema_version": 0, "sha256": "string", "generated_by": "string", "has_pdf": true, "csv_tables": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "generated": true, "data": {}}