CentralCSP
APIReports

List individual reports

Lists individual reports, newest first, as they were received. Use it to inspect specific reports, and the breakdown endpoints to see patterns. Reports are kept for 90 days.

Requires the viewer role on the website and the report type's plan feature.

GET
/v1/workspaces/{workspaceId}/websites/{websiteId}/reports/{type}/raw

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

websiteId*string

The website's id.

type*string

Which kind of report to read. A website only collects the types its plan includes and its settings allow.

Value in"csp-violation""csp-hash""integrity-violation""permissions-policy-violation""potential-permissions-policy-violation""document-policy-violation""connection-allowlist""intervention""deprecation""crash""coop""coep""network-error"

Query Parameters

range*string

How far back to look, counted from now. Reports are kept for 90 days, so 90d is the widest range available.

Default"7d"
Value in"24h""7d""30d""90d"
search?string

Match part of the page URL a report came from.

Lengthlength <= 1024
browser?string

Only reports from this browser.

Lengthlength <= 255
directive?string

Only reports for this CSP directive.

Lengthlength <= 255
disposition?string

Only enforce or only report reports.

Lengthlength <= 255
destination?string

Only reports for this request destination, such as script.

Lengthlength <= 255
hashAlgorithm?string

Only reports using this hash algorithm.

Lengthlength <= 255
policy?string

Only reports naming this policy.

Lengthlength <= 255
visibility?string

Only reports from pages in this visibility state, such as visible.

Lengthlength <= 255
kind?string

Only reports of this kind, such as tcp.refused.

Lengthlength <= 255
phase?string

Only reports raised in this phase, such as dns, connection or application.

Lengthlength <= 255
cursor?string

The nextCursor of the previous page.

limit*|

How many reports to return, from 1 to 200.

Range1 <= value <= 200
Default50

Response Body

A page of reports.

application/json
  1. response
data*array<>

The reports on this page.

pagination*

Where this page sits in the full result set.

Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/reports/csp-violation/raw?range=24h&limit=50'
Example Response
{  "data": [    {      "id": "string",      "type": "csp-violation",      "receivedAt": "2019-08-24T14:15:22Z",      "url": "https://shop.example.com/checkout",      "userAgent": {        "family": "Chrome",        "version": "121",        "os": "macOS"      },      "data": {}    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true,    "total": 0  }}

Export individual reports GET

Streams individual reports as CSV, newest first, with the same filters as the list endpoint and no pagination. The columns depend on the report type.

Export the report breakdown GET

Streams the whole breakdown as CSV, with the same filters as the breakdown endpoint and no pagination.