Reports API

10 operations from the external ASIRI OpenAPI surface.

Public endpoint

GET`/v1/reports/audit-summary`

Audit-event summary

Counts of audit events grouped by module + action over the period.

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`from`	query	yes	`string`	-
`to`	query	yes	`string`	-

Request body

No request body.

Responses

GET/v1/reports/audit-summaryPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/audit-summary?from=2026-01-01&to=2026-01-31' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "from": "string",
    "to": "string",
    "rows": [
      {
        "module": "string",
        "action": "string",
        "count": 1
      }
    ],
    "totalEvents": 1
  }
}

Public endpoint

GET`/v1/reports/breach-timeline`

Breach incidence timeline

ISO-week buckets of breach incidents over the period, grouped by severity.

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`from`	query	yes	`string`	-
`to`	query	yes	`string`	-

Request body

No request body.

Responses

GET/v1/reports/breach-timelinePublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/breach-timeline?from=2026-01-01&to=2026-01-31' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "from": "string",
    "to": "string",
    "buckets": [
      {
        "weekStart": "string",
        "total": 1,
        "bySeverity": {
          "key": "value"
        }
      }
    ]
  }
}

Public endpoint

POST`/v1/reports/build`

Queue a new report build

Requiresreports:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

application/jsonobject

Responses

POST/v1/reports/buildPublic schema

curl --request POST \
  --url 'https://api.asiri.ng/v1/reports/build' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "audit_summary",
  "format": "pdf",
  "from": "2026-01-15T10:30:00.000Z",
  "to": "2026-01-15T10:30:00.000Z",
  "recipients": [
    "developer@example.com"
  ]
}'

Example response202

application/json

{
  "data": {
    "reportId": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
    "status": "queued"
  }
}

Public endpoint

GET`/v1/reports/dsr-risk-mix`

DSR risk-band distribution

Heuristic bucketing of open DSRs by SLA pressure: overdue → high, due within 7 days → moderate, otherwise low. Closed DSRs count as none.

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

No request body.

Responses

GET/v1/reports/dsr-risk-mixPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/dsr-risk-mix' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "generatedAt": "string",
    "high": 1,
    "moderate": 1,
    "low": 1,
    "none": 1
  }
}

Public endpoint

GET`/v1/reports/dsr-sla`

DSR SLA throughput report

Period-scoped DSR throughput, mean times to acknowledge and fulfil, and SLA-breach count.

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`from`	query	yes	`string`	-
`to`	query	yes	`string`	-

Request body

No request body.

Responses

GET/v1/reports/dsr-slaPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/dsr-sla?from=2026-01-01&to=2026-01-31' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "from": "string",
    "to": "string",
    "throughput": {
      "byStatus": {
        "key": 1
      },
      "total": 1
    },
    "meanTimeToAcknowledgeSeconds": 1,
    "meanTimeToFulfilSeconds": 1,
    "slaBreachCount": 1
  }
}

Public endpoint

GET`/v1/reports/forecast`

Monthly task forecast

Counts of items due in each of the next 4 months across DSR SLA, DPIA reviews, cross-border reviews, policy reviews, and RoPA reviews.

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

No request body.

Responses

GET/v1/reports/forecastPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/forecast' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "generatedAt": "string",
    "months": [
      {
        "label": "string",
        "value": 1
      }
    ]
  }
}

Public endpoint

GET`/v1/reports/frameworks`

Per-framework readiness

For each active ControlFramework: count of requirements, count of mapped controls, and percent of those controls in `implemented` status for the tenant.

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

No request body.

Responses

GET/v1/reports/frameworksPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/frameworks' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "generatedAt": "string",
    "items": [
      {
        "code": "string",
        "name": "string",
        "requirements": 1,
        "controls": 1,
        "readyPct": 1
      }
    ]
  }
}

Public endpoint

GET`/v1/reports/overview`

Compliance overview snapshot

Tenant-wide counts across all NDPA modules (DSR, breach, DPIA, consent, …).

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

No request body.

Responses

GET/v1/reports/overviewPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/overview' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "generatedAt": "string",
    "dsr": {
      "open": 1,
      "byStatus": {
        "key": 1
      }
    },
    "breach": {
      "open": 1,
      "overdue72h": 1,
      "byStatus": {
        "key": 1
      }
    },
    "dpia": {
      "awaitingApproval": 1,
      "blocked": 1
    },
    "consent": {
      "liveNotices": 1
    },
    "policy": {
      "needingReview": 1
    }
  }
}

Public endpoint

GET`/v1/reports/runs`

List recent report runs for this tenant

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`cursor`	query	no	`string`	-
`limit`	query	no	`integer`	-

Request body

No request body.

Responses

GET/v1/reports/runsPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/runs' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "items": [
      {
        "id": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
        "type": "audit_summary",
        "format": "pdf",
        "status": "queued",
        "params": {
          "key": "value"
        },
        "artefactPath": "string"
      }
    ],
    "nextCursor": "string"
  }
}

Public endpoint

GET`/v1/reports/runs/{id}`

Get a single report run

Requiresreports:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

No request body.

Responses

GET/v1/reports/runs/{id}Public schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/reports/runs/{id}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "id": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
    "type": "audit_summary",
    "format": "pdf",
    "status": "queued",
    "params": {
      "key": "value"
    },
    "artefactPath": "string"
  }
}

Reports API

GET/v1/reports/audit-summary

Security

Parameters

Request body

Responses

GET/v1/reports/breach-timeline

Security

Parameters

Request body

Responses

POST/v1/reports/build

Security

Parameters

Request body

Responses

GET/v1/reports/dsr-risk-mix

Security

Parameters

Request body

Responses

GET/v1/reports/dsr-sla

Security

Parameters

Request body

Responses

GET/v1/reports/forecast

Security

Parameters

Request body

Responses

GET/v1/reports/frameworks

Security

Parameters

Request body

Responses

GET/v1/reports/overview

Security

Parameters

Request body

Responses

GET/v1/reports/runs

Security

Parameters

Request body

Responses

GET/v1/reports/runs/{id}

Security

Parameters

Request body

Responses

GET`/v1/reports/audit-summary`

GET`/v1/reports/breach-timeline`

POST`/v1/reports/build`

GET`/v1/reports/dsr-risk-mix`

GET`/v1/reports/dsr-sla`

GET`/v1/reports/forecast`

GET`/v1/reports/frameworks`

GET`/v1/reports/overview`

GET`/v1/reports/runs`

GET`/v1/reports/runs/{id}`