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": 4905, "culture": 6, "description": "value", "emails": "value", "end_at": "2018-11-03 03:38:31", "format": 0, "frequency": "value", "name": "value", "report_id": 3668, "start_at": "2018-11-03 03:33:34" } ], "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
frequency array
Array of frequency config options
Array of frequency config options
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1 Host: l7api.com { "report_id": 556, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2023-09-12", "end_at": "2023-09-12", "frequency": { "type": "W", "time_of_day": [ 10 ], "day_of_week": [ 1, 5 ], "day_of_month": [] } }
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": 5120, "culture": 0, "description": "value", "emails": "value", "end_at": "2017-12-19 20:33:27", "format": 0, "frequency": "value", "name": "value", "report_id": 4602, "start_at": "2017-12-19 20:36:28" }, "links": {} }
GET
/reportschedules/{id} Returns Report schedule resource for given Id
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
GET /v1.1/voipstudio/reportschedules/28 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": 3857, "culture": 3, "description": "value", "emails": "value", "end_at": "2016-10-26 18:57:45", "format": 0, "frequency": "value", "name": "value", "report_id": 8006, "start_at": "2016-10-26 18:57:04" }, "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
frequency array
Array of frequency config options
Array of frequency config options
Example Request
PATCH /v1.1/voipstudio/reportschedules/71 HTTP/1.1 Host: l7api.com { "report_id": 163, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2023-09-12", "end_at": "2023-09-12", "frequency": { "type": "W", "time_of_day": [ 10 ], "day_of_week": [ 1, 5 ], "day_of_month": [] } }
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": 5496, "culture": 6, "description": "value", "emails": "value", "end_at": "2018-08-10 01:44:57", "format": 0, "frequency": "value", "name": "value", "report_id": 1852, "start_at": "2018-08-10 02:00:37" }, "links": {} }
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/23 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": 1509, "culture": 2, "description": "value", "emails": "value", "end_at": "2022-01-12 18:29:12", "format": 0, "frequency": "value", "name": "value", "report_id": 9683, "start_at": "2022-01-12 18:37:26" } ], "total": 59 }