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": 2432, "created_at": "2016-09-29 19:04:10", "culture": 7, "description": "value", "emails": "value", "end_at": "2016-09-29 19:16:30", "format": 0, "frequency": "value", "last_run_at": "2016-09-29 19:11:18", "name": "value", "next_run_at": "2016-09-29 19:11:15", "report_id": 166, "start_at": "2016-09-29 19:05:48", "status": 1, "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": 950, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-08-14", "end_at": "2025-08-14", "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": 3524, "created_at": "2020-10-05 07:37:42", "culture": 7, "description": "value", "emails": "value", "end_at": "2020-10-05 07:22:22", "format": 1, "frequency": "value", "last_run_at": "2020-10-05 07:32:58", "name": "value", "next_run_at": "2020-10-05 07:29:32", "report_id": 289, "start_at": "2020-10-05 07:27:38", "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/45 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": 4511, "created_at": "2016-12-13 22:53:30", "culture": 0, "description": "value", "emails": "value", "end_at": "2016-12-13 22:51:28", "format": 0, "frequency": "value", "last_run_at": "2016-12-13 22:51:15", "name": "value", "next_run_at": "2016-12-13 22:59:03", "report_id": 4842, "start_at": "2016-12-13 22:49:04", "status": 1, "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/99 HTTP/1.1 Host: l7api.com { "report_id": 496, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-08-14", "end_at": "2025-08-14", "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": 4561, "created_at": "2018-01-31 19:14:18", "culture": 0, "description": "value", "emails": "value", "end_at": "2018-01-31 19:14:54", "format": 1, "frequency": "value", "last_run_at": "2018-01-31 19:23:17", "name": "value", "next_run_at": "2018-01-31 19:14:22", "report_id": 6592, "start_at": "2018-01-31 19:20:55", "status": 0, "timezone": "value" }, "links": {} }
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/29 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": 8994, "created_at": "2020-09-25 20:12:14", "culture": 0, "description": "value", "emails": "value", "end_at": "2020-09-25 20:13:28", "format": 0, "frequency": "value", "last_run_at": "2020-09-25 20:11:53", "name": "value", "next_run_at": "2020-09-25 20:10:02", "report_id": 9600, "start_at": "2020-09-25 20:11:18", "status": 1, "timezone": "value" } ], "total": 59 }