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": 3976, "created_at": "2023-09-16 01:19:56", "culture": 7, "description": "value", "emails": "value", "end_at": "2023-09-16 01:28:17", "format": 0, "frequency": "value", "last_run_at": "2023-09-16 01:22:05", "name": "value", "next_run_at": "2023-09-16 01:23:48", "report_id": 3738, "start_at": "2023-09-16 01:18:58", "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": 650, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-03-18", "end_at": "2024-03-18", "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": 9282, "created_at": "2018-04-29 20:28:46", "culture": 4, "description": "value", "emails": "value", "end_at": "2018-04-29 20:26:49", "format": 0, "frequency": "value", "last_run_at": "2018-04-29 20:14:08", "name": "value", "next_run_at": "2018-04-29 20:15:01", "report_id": 6839, "start_at": "2018-04-29 20:25:06", "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/43 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": 2142, "created_at": "2023-07-16 13:03:10", "culture": 4, "description": "value", "emails": "value", "end_at": "2023-07-16 13:00:28", "format": 0, "frequency": "value", "last_run_at": "2023-07-16 13:08:51", "name": "value", "next_run_at": "2023-07-16 13:06:28", "report_id": 7103, "start_at": "2023-07-16 12:58:07", "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/39 HTTP/1.1 Host: l7api.com { "report_id": 274, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-03-18", "end_at": "2024-03-18", "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": 7635, "created_at": "2020-07-04 08:32:24", "culture": 7, "description": "value", "emails": "value", "end_at": "2020-07-04 08:32:11", "format": 0, "frequency": "value", "last_run_at": "2020-07-04 08:35:18", "name": "value", "next_run_at": "2020-07-04 08:33:53", "report_id": 3961, "start_at": "2020-07-04 08:25:01", "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/10 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": 7240, "created_at": "2017-05-11 21:36:47", "culture": 2, "description": "value", "emails": "value", "end_at": "2017-05-11 21:45:56", "format": 0, "frequency": "value", "last_run_at": "2017-05-11 21:46:19", "name": "value", "next_run_at": "2017-05-11 21:50:13", "report_id": 1530, "start_at": "2017-05-11 21:35:23", "status": 0, "timezone": "value" } ], "total": 59 }