1. Partner API v2
  2. Resources
  3. Reports

Reports

Generated PDF and Excel reports in the client's archive.
2 endpointsScope readReport
GET/v2/clients/{client_id}/reports
RequiresreadscopeCursor-paginatedReturns Page of Report

Reports in the client's archive, newest first. The download link is on the detail call because it is signed and short-lived.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

typestring

Open enum.

One ofexecutive_summaryrisk_overviewphishing_overviewtraining_overviewtraining_performanceemployee_historycourse_detailscompliancepolicypolicy_acknowledgmentdark_webmonthly_reporttraining_status_reportmanager_dept_training_reportphishing_performanceglobal_health_report
sincestring (date-time)

Only records at or after this time (RFC 3339).

limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/reports" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Report
dataarray of Report
Show item properties(8)
idstring
client_idstring
typestring

Open enum.

One ofexecutive_summaryrisk_overviewphishing_overviewtraining_overviewtraining_performanceemployee_historycourse_detailscompliancepolicypolicy_acknowledgmentdark_webmonthly_reporttraining_status_reportmanager_dept_training_reportphishing_performanceglobal_health_report
formatstring
One ofpdfxlsx
statusstring
One ofpendingreadyfailed
periodobjectNullable
Show properties(2)
start_onstring (date)
end_onstring (date)
download_urlstringNullable

Signed, valid 24 hours. Only on the detail call and only when status is ready.

created_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
GET/v2/clients/{client_id}/reports/{report_id}
RequiresreadscopeReturns Report

download_url is a signed link valid for 24 hours. Fetch a fresh one rather than storing it.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

report_idstringRequired

Report id, as returned by the report list.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/reports/4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectReport
idstring
client_idstring
typestring

Open enum.

One ofexecutive_summaryrisk_overviewphishing_overviewtraining_overviewtraining_performanceemployee_historycourse_detailscompliancepolicypolicy_acknowledgmentdark_webmonthly_reporttraining_status_reportmanager_dept_training_reportphishing_performanceglobal_health_report
formatstring
One ofpdfxlsx
statusstring
One ofpendingreadyfailed
periodobjectNullable
Show properties(2)
start_onstring (date)
end_onstring (date)
download_urlstringNullable

Signed, valid 24 hours. Only on the detail call and only when status is ready.

created_atstring (date-time)
Errors404Not found within the key's accessError envelope →
Coming in 2.x1 more Reports operation is specified for a later 2.x release.See the roadmap