Reports module
Endpoints
Endpoints for managing Reportings
GET
/reportschedules Returns collection of Report schedule resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/reportschedules HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "id": 7373, "created_at": "2023-10-13 10:23:05", "culture": 4, "description": "value", "emails": "value", "end_at": "2023-10-13 10:14:58", "format": 0, "frequency": "value", "last_run_at": "2023-10-13 10:10:03", "name": "value", "next_run_at": "2023-10-13 10:17:37", "report_id": 8713, "start_at": "2023-10-13 10:15:32", "status": 0, "timezone": "value" } ], "total": 59 }
POST
/reportschedules Creates new Report schedule resource
Parameters
JSON body attributes:
report_id integer
name string
description string
emails array
Array of emails
Array of emails
format string
culture string
start_at date
end_at date
status string
frequency array
Array of frequency config options
Array of frequency config options
timezone string
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1 Host: l7api.com { "report_id": 975, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-10-07", "end_at": "2025-10-07", "status": "abcd", "frequency": { "type": "W", "time_of_day": [ 10 ], "day_of_week": [ 1, 5 ], "day_of_month": [] }, "timezone": "abcd" }
Responses
201 Success
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK Content-Type: application/json { "data": { "id": 4211, "created_at": "2020-10-01 00:04:53", "culture": 2, "description": "value", "emails": "value", "end_at": "2020-09-30 23:52:27", "format": 1, "frequency": "value", "last_run_at": "2020-10-01 00:02:01", "name": "value", "next_run_at": "2020-09-30 23:51:25", "report_id": 2350, "start_at": "2020-09-30 23:52:23", "status": 0, "timezone": "value" }, "links": {} }
GET
/reportschedules/{id} Returns Report schedule resource for given Id
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
GET /v1.1/voipstudio/reportschedules/65 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 5285, "created_at": "2016-12-11 02:10:14", "culture": 4, "description": "value", "emails": "value", "end_at": "2016-12-11 02:22:06", "format": 1, "frequency": "value", "last_run_at": "2016-12-11 02:21:31", "name": "value", "next_run_at": "2016-12-11 02:19:55", "report_id": 8535, "start_at": "2016-12-11 02:23:09", "status": 0, "timezone": "value" }, "links": {} }
PATCH
/reportschedules/{id} Updates existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
JSON body attributes:
report_id integer
name string
description string
emails array
Array of emails
Array of emails
format string
culture string
start_at date
end_at date
status string
frequency array
Array of frequency config options
Array of frequency config options
timezone string
Example Request
PATCH /v1.1/voipstudio/reportschedules/95 HTTP/1.1 Host: l7api.com { "report_id": 176, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-10-07", "end_at": "2025-10-07", "status": "abcd", "frequency": { "type": "W", "time_of_day": [ 10 ], "day_of_week": [ 1, 5 ], "day_of_month": [] }, "timezone": "abcd" }
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 1707, "created_at": "2023-06-08 20:06:33", "culture": 0, "description": "value", "emails": "value", "end_at": "2023-06-08 20:16:06", "format": 0, "frequency": "value", "last_run_at": "2023-06-08 20:02:35", "name": "value", "next_run_at": "2023-06-08 20:08:58", "report_id": 2098, "start_at": "2023-06-08 20:11:26", "status": 1, "timezone": "value" }, "links": {} }
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/44 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/reportschedules/dictionaries Returns Dictionary for Report schedule resource
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/reportschedules/dictionaries HTTP/1.1 Host: l7api.com
Responses
200 Success
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "id": 6574, "created_at": "2025-06-24 03:33:41", "culture": 5, "description": "value", "emails": "value", "end_at": "2025-06-24 03:42:36", "format": 1, "frequency": "value", "last_run_at": "2025-06-24 03:42:37", "name": "value", "next_run_at": "2025-06-24 03:35:13", "report_id": 8834, "start_at": "2025-06-24 03:40:54", "status": 1, "timezone": "value" } ], "total": 59 }