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": 524, "created_at": "2024-10-09 21:30:23", "culture": 1, "description": "value", "emails": "value", "end_at": "2024-10-09 21:31:26", "format": 0, "frequency": "value", "last_run_at": "2024-10-09 21:30:57", "name": "value", "next_run_at": "2024-10-09 21:36:08", "report_id": 4059, "start_at": "2024-10-09 21:28:12", "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": 286, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-03-28", "end_at": "2025-03-28", "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": 8573, "created_at": "2025-02-21 06:05:23", "culture": 5, "description": "value", "emails": "value", "end_at": "2025-02-21 06:08:39", "format": 0, "frequency": "value", "last_run_at": "2025-02-21 06:03:55", "name": "value", "next_run_at": "2025-02-21 06:21:38", "report_id": 3056, "start_at": "2025-02-21 06:09:33", "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/84 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": 2901, "created_at": "2024-05-20 07:14:02", "culture": 6, "description": "value", "emails": "value", "end_at": "2024-05-20 07:10:33", "format": 0, "frequency": "value", "last_run_at": "2024-05-20 07:10:37", "name": "value", "next_run_at": "2024-05-20 07:15:57", "report_id": 6018, "start_at": "2024-05-20 07:15:19", "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/46 HTTP/1.1 Host: l7api.com { "report_id": 723, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "format": "abcd", "culture": "abcd", "start_at": "2025-03-28", "end_at": "2025-03-28", "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": 5838, "created_at": "2024-04-26 14:29:59", "culture": 2, "description": "value", "emails": "value", "end_at": "2024-04-26 14:28:21", "format": 0, "frequency": "value", "last_run_at": "2024-04-26 14:16:56", "name": "value", "next_run_at": "2024-04-26 14:21:58", "report_id": 3124, "start_at": "2024-04-26 14:24:45", "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/66 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": 9451, "created_at": "2020-04-02 07:43:44", "culture": 7, "description": "value", "emails": "value", "end_at": "2020-04-02 07:42:09", "format": 0, "frequency": "value", "last_run_at": "2020-04-02 07:41:38", "name": "value", "next_run_at": "2020-04-02 07:40:53", "report_id": 2523, "start_at": "2020-04-02 07:40:26", "status": 1, "timezone": "value" } ], "total": 59 }