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": 4287, "created_at": "2024-10-04 21:59:50", "culture": 3, "description": "value", "emails": "value", "end_at": "2024-10-04 22:13:10", "format": 1, "frequency": "value", "last_run_at": "2024-10-04 22:10:22", "name": "value", "next_run_at": "2024-10-04 22:00:13", "report_id": 315, "start_at": "2024-10-04 22:14:25", "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": 527, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-05-02", "end_at": "2025-05-02", "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": 9979, "created_at": "2020-08-07 12:18:13", "culture": 5, "description": "value", "emails": "value", "end_at": "2020-08-07 12:10:04", "format": 1, "frequency": "value", "last_run_at": "2020-08-07 12:11:05", "name": "value", "next_run_at": "2020-08-07 12:10:22", "report_id": 8211, "start_at": "2020-08-07 12:13:23", "status": 1, "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/34 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": 3298, "created_at": "2021-03-09 07:55:34", "culture": 7, "description": "value", "emails": "value", "end_at": "2021-03-09 08:03:13", "format": 1, "frequency": "value", "last_run_at": "2021-03-09 07:52:24", "name": "value", "next_run_at": "2021-03-09 07:55:52", "report_id": 7820, "start_at": "2021-03-09 07:52:54", "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/39 HTTP/1.1 Host: l7api.com { "report_id": 831, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-05-02", "end_at": "2025-05-02", "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": 8814, "created_at": "2022-12-04 02:46:22", "culture": 5, "description": "value", "emails": "value", "end_at": "2022-12-04 02:46:10", "format": 1, "frequency": "value", "last_run_at": "2022-12-04 02:53:54", "name": "value", "next_run_at": "2022-12-04 02:43:22", "report_id": 8473, "start_at": "2022-12-04 02:58:09", "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/4 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": 9908, "created_at": "2023-11-11 09:40:19", "culture": 2, "description": "value", "emails": "value", "end_at": "2023-11-11 09:38:18", "format": 0, "frequency": "value", "last_run_at": "2023-11-11 09:35:10", "name": "value", "next_run_at": "2023-11-11 09:39:16", "report_id": 7010, "start_at": "2023-11-11 09:36:54", "status": 0, "timezone": "value" } ], "total": 59 }