Reports

Didomi continuously scans websites and mobile applications to extract raw information (page content, HTTP requests, cookies, etc.) and build higher-level compliance reports.

The /reports endpoint of the API exposes the compliance reports generated by Didomi from its scans. For a full reference of the endpoint and the resources that it returns, visit https://api.didomi.io/docs/.

Querying reports

A report can be generated by specifying the property_id that you want to report on as well as the report period: a period_start and period_end query-string parameters formatted as ISO8601 dates.

Example:

curl --request GET --url 'https://api.didomi.io/v1/reports?property_id=S1gJhiZVA&period_start=2018-01-10T00:00:00.000Z&period_end=2018-01-17T23:59:59.000Z' --header 'authorization: Bearer <Access token>'

By default, this will return a basic report formatted as JSON.

Basic vs full reports

We support two types of reports. The type query-string parameter can be used to switch from one type of report to the other. The default report generated is the basic one if the type parameter is omitted.

The basic report only presents high-level information on the property compliance and its vendors. All the information displayed when looking up a report in the Didomi Console is included but nothing more.

The full report includes all the information from the basic report as well as the full list of HTTP requests that were captured and categorized. A full report can get pretty heavy (multiple MBs) and slow to generate depending on the report period and the property activity.

JSON vs Excel reports

We support two formats for our generated reports: JSON or Excel. The format query-string parameter can be used to switch from one format to the other. The default format is json. Specify xlsx to get an Excel report instead.