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": 7909, "created_at": "2024-02-23 14:59:23", "culture": 7, "description": "value", "emails": "value", "end_at": "2024-02-23 14:56:05", "format": 0, "frequency": "value", "last_run_at": "2024-02-23 14:49:20", "name": "value", "next_run_at": "2024-02-23 14:45:50", "report_id": 1193, "start_at": "2024-02-23 14:59:55", "status": 1, "timezone": "value", "tz": "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
tz string
timezone string
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1 Host: l7api.com { "report_id": 742, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-10-22", "end_at": "2025-10-22", "status": "abcd", "frequency": { "type": "W", "time_of_day": [ 10 ], "day_of_week": [ 1, 5 ], "day_of_month": [] }, "tz": "abcd", "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": 6259, "created_at": "2021-01-01 02:13:50", "culture": 2, "description": "value", "emails": "value", "end_at": "2021-01-01 02:20:05", "format": 0, "frequency": "value", "last_run_at": "2021-01-01 02:33:03", "name": "value", "next_run_at": "2021-01-01 02:15:39", "report_id": 655, "start_at": "2021-01-01 02:23:37", "status": 0, "timezone": "value", "tz": "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/26 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": 5953, "created_at": "2022-01-19 16:44:19", "culture": 1, "description": "value", "emails": "value", "end_at": "2022-01-19 16:51:56", "format": 0, "frequency": "value", "last_run_at": "2022-01-19 16:44:55", "name": "value", "next_run_at": "2022-01-19 16:42:30", "report_id": 9281, "start_at": "2022-01-19 16:44:01", "status": 0, "timezone": "value", "tz": "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
tz string
timezone string
Example Request
PATCH /v1.1/voipstudio/reportschedules/36 HTTP/1.1 Host: l7api.com { "report_id": 978, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-10-22", "end_at": "2025-10-22", "status": "abcd", "frequency": { "type": "W", "time_of_day": [ 10 ], "day_of_week": [ 1, 5 ], "day_of_month": [] }, "tz": "abcd", "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": 5551, "created_at": "2018-12-28 18:48:10", "culture": 6, "description": "value", "emails": "value", "end_at": "2018-12-28 19:01:41", "format": 0, "frequency": "value", "last_run_at": "2018-12-28 18:44:55", "name": "value", "next_run_at": "2018-12-28 18:50:41", "report_id": 795, "start_at": "2018-12-28 18:53:08", "status": 1, "timezone": "value", "tz": "value" }, "links": {} }
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/32 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": 1854, "created_at": "2023-01-01 03:44:19", "culture": 5, "description": "value", "emails": "value", "end_at": "2023-01-01 03:49:17", "format": 1, "frequency": "value", "last_run_at": "2023-01-01 03:41:23", "name": "value", "next_run_at": "2023-01-01 03:39:24", "report_id": 5617, "start_at": "2023-01-01 03:37:34", "status": 1, "timezone": "value", "tz": "value" } ], "total": 59 }