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": 449, "created_at": "2021-03-30 08:19:59", "culture": 5, "description": "value", "emails": "value", "end_at": "2021-03-30 08:31:39", "format": 0, "frequency": "value", "last_run_at": "2021-03-30 08:18:31", "name": "value", "next_run_at": "2021-03-30 08:32:21", "report_id": 6983, "start_at": "2021-03-30 08:15:45", "status": 0, "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": 176, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-10-21", "end_at": "2024-10-21", "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": 8304, "created_at": "2016-06-11 17:01:31", "culture": 2, "description": "value", "emails": "value", "end_at": "2016-06-11 17:00:50", "format": 0, "frequency": "value", "last_run_at": "2016-06-11 17:11:07", "name": "value", "next_run_at": "2016-06-11 16:53:37", "report_id": 9266, "start_at": "2016-06-11 16:55:24", "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/10 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": 7701, "created_at": "2018-05-10 19:45:27", "culture": 0, "description": "value", "emails": "value", "end_at": "2018-05-10 19:38:48", "format": 0, "frequency": "value", "last_run_at": "2018-05-10 19:33:50", "name": "value", "next_run_at": "2018-05-10 19:46:30", "report_id": 8331, "start_at": "2018-05-10 19:35:49", "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
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/77 HTTP/1.1 Host: l7api.com { "report_id": 729, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-10-21", "end_at": "2024-10-21", "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": 7873, "created_at": "2018-05-31 23:04:31", "culture": 5, "description": "value", "emails": "value", "end_at": "2018-05-31 23:03:40", "format": 0, "frequency": "value", "last_run_at": "2018-05-31 22:55:49", "name": "value", "next_run_at": "2018-05-31 22:49:59", "report_id": 2555, "start_at": "2018-05-31 23:09:19", "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/65 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": 5136, "created_at": "2021-01-02 15:16:26", "culture": 3, "description": "value", "emails": "value", "end_at": "2021-01-02 15:27:16", "format": 0, "frequency": "value", "last_run_at": "2021-01-02 15:15:34", "name": "value", "next_run_at": "2021-01-02 15:10:09", "report_id": 1161, "start_at": "2021-01-02 15:23:22", "status": 1, "timezone": "value" } ], "total": 59 }