Reports module
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": 4493, "created_at": "2023-05-11 12:02:33", "culture": 2, "description": "value", "emails": "value", "end_at": "2023-05-11 12:01:26", "format": 0, "frequency": "value", "last_run_at": "2023-05-11 12:17:09", "name": "value", "next_run_at": "2023-05-11 12:11:25", "report_id": 4016, "start_at": "2023-05-11 12:07:03", "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
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": 979, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-05-09", "end_at": "2024-05-09", "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": 383, "created_at": "2016-08-01 09:24:03", "culture": 0, "description": "value", "emails": "value", "end_at": "2016-08-01 09:17:32", "format": 0, "frequency": "value", "last_run_at": "2016-08-01 09:20:11", "name": "value", "next_run_at": "2016-08-01 09:12:49", "report_id": 6323, "start_at": "2016-08-01 09:20:43", "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": 1443, "created_at": "2023-06-27 03:26:29", "culture": 2, "description": "value", "emails": "value", "end_at": "2023-06-27 03:20:57", "format": 0, "frequency": "value", "last_run_at": "2023-06-27 03:28:17", "name": "value", "next_run_at": "2023-06-27 03:22:22", "report_id": 7713, "start_at": "2023-06-27 03:30:14", "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
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/94 HTTP/1.1 Host: l7api.com { "report_id": 245, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-05-09", "end_at": "2024-05-09", "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": 9592, "created_at": "2021-06-23 19:14:00", "culture": 2, "description": "value", "emails": "value", "end_at": "2021-06-23 19:20:36", "format": 0, "frequency": "value", "last_run_at": "2021-06-23 19:06:37", "name": "value", "next_run_at": "2021-06-23 19:09:55", "report_id": 3906, "start_at": "2021-06-23 19:10:44", "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/35 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": 3777, "created_at": "2022-07-01 12:59:53", "culture": 0, "description": "value", "emails": "value", "end_at": "2022-07-01 13:09:23", "format": 0, "frequency": "value", "last_run_at": "2022-07-01 13:00:10", "name": "value", "next_run_at": "2022-07-01 13:08:48", "report_id": 8642, "start_at": "2022-07-01 12:54:20", "status": 1, "timezone": "value" } ], "total": 59 }