Report
Properties
-
id(integer): Unique event identifier. -
timestamp(string, format: date-time)Examples:
"2018-11-13T20:20:39+00:00" -
user(['string', 'null'], format: uri-reference): Optional resource of user who triggered the event.Examples:
"/users/123" -
event_type(string): Must be one of:["report"]. -
event(string): Must be one of:["create", "delete"]. -
parent_group(string, format: uri-reference): Direct parent group's resource.Examples:
"/groups/12" -
schedule_resource(['string', 'null'], format: uri-reference): Resource of the schedule that caused this report, or null for a manual report.Examples:
"/scheduled_reports/6lGbAzqy" -
report_resource(string, format: uri-reference)Examples:
"/report_statuses/1" -
report_file_resource(string, format: uri-reference): Links to the generated PDF file. -
timezone(string): TZDB Zone Identifier.Examples:
"UTC""Africa/Abidjan" -
start_date(string, format: date-time): Report data start datetime. -
end_date(string, format: date-time): Report data end datetime. -
report_display_name(string) -
report_entity(string): Must be one of:["group", "zone", "victim"]. -
entity_resource(string, format: uri-reference): Resource that this report describes.
Examples
{
"id": 1,
"timestamp": "2018-11-13T20:20:39+00:00",
"user": "/users/100",
"event_type": "report",
"event": "create",
"parent_group": "/groups/12",
"schedule_resource": null,
"report_resource": "/report_statuses/1",
"report_file_resource": "/report_statuses/1/download",
"timezone": "America/New_York",
"start_date": "2024-03-25T16:15:00+00:00",
"end_date": "2024-03-26T16:15:00+00:00",
"report_display_name": "Daily Group Report",
"entity_resource": "/groups/21",
"report_entity": "group"
}