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": 1962, "created_at": "2021-08-26 02:14:49", "culture": 6, "description": "value", "emails": "value", "end_at": "2021-08-26 02:19:44", "format": 0, "frequency": "value", "last_run_at": "2021-08-26 02:14:18", "name": "value", "next_run_at": "2021-08-26 02:14:04", "report_id": 2469, "start_at": "2021-08-26 02:23:34", "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": 505, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-01-11", "end_at": "2024-01-11", "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": 2080, "created_at": "2020-07-19 17:23:53", "culture": 2, "description": "value", "emails": "value", "end_at": "2020-07-19 17:23:52", "format": 0, "frequency": "value", "last_run_at": "2020-07-19 17:39:55", "name": "value", "next_run_at": "2020-07-19 17:39:54", "report_id": 8252, "start_at": "2020-07-19 17:39:40", "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/41 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": 1600, "created_at": "2019-02-06 19:38:35", "culture": 3, "description": "value", "emails": "value", "end_at": "2019-02-06 19:37:11", "format": 0, "frequency": "value", "last_run_at": "2019-02-06 19:49:29", "name": "value", "next_run_at": "2019-02-06 19:37:13", "report_id": 8659, "start_at": "2019-02-06 19:45:31", "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/37 HTTP/1.1 Host: l7api.com { "report_id": 599, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-01-11", "end_at": "2024-01-11", "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": 8557, "created_at": "2017-05-26 14:27:56", "culture": 2, "description": "value", "emails": "value", "end_at": "2017-05-26 14:11:53", "format": 0, "frequency": "value", "last_run_at": "2017-05-26 14:16:35", "name": "value", "next_run_at": "2017-05-26 14:24:35", "report_id": 1247, "start_at": "2017-05-26 14:15:00", "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/73 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": 3977, "created_at": "2022-06-21 18:30:13", "culture": 0, "description": "value", "emails": "value", "end_at": "2022-06-21 18:31:48", "format": 0, "frequency": "value", "last_run_at": "2022-06-21 18:37:57", "name": "value", "next_run_at": "2022-06-21 18:38:04", "report_id": 3855, "start_at": "2022-06-21 18:35:12", "status": 1, "timezone": "value" } ], "total": 59 }