Proteside Docs
Referência de endpointsRelatórios PCI

Um snapshot específico (JSON, PDF ou CSV)

GET
/reports/pci/snapshots/{id}

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de consulta

org_id?string

Somente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.

Formatouuid
format?string
Padrão"json"
Valor em"json""pdf""csv"
csv_table?string
Padrão"scripts"
Valor em"scripts""headers""alerts"

Corpo da resposta

Snapshot com dados

  1. response
id?string
Formatouuid
store_id?string
Formatouuid
kind?string
Valor em"weekly""on_demand""monthly"
period_start?string
Formatodate-time
period_end?string
Formatodate-time
locale?string
Valor em"pt-BR""en"
schema_version?integer
sha256?string|null
generated_by?string
has_pdf?boolean
csv_tables?array<string>
created_at?string
Formatodate-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/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": {}}