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": 7693, "created_at": "2020-12-23 16:38:57", "culture": 1, "description": "value", "emails": "value", "end_at": "2020-12-23 16:22:49", "format": 0, "frequency": "value", "last_run_at": "2020-12-23 16:27:10", "name": "value", "next_run_at": "2020-12-23 16:35:47", "report_id": 7351, "start_at": "2020-12-23 16:27:22", "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": 334, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-03-06", "end_at": "2024-03-06", "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": 1832, "created_at": "2017-05-07 11:08:44", "culture": 5, "description": "value", "emails": "value", "end_at": "2017-05-07 10:59:41", "format": 0, "frequency": "value", "last_run_at": "2017-05-07 10:54:42", "name": "value", "next_run_at": "2017-05-07 11:10:28", "report_id": 4750, "start_at": "2017-05-07 10:59:16", "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/70 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": 8687, "created_at": "2022-05-15 00:04:46", "culture": 7, "description": "value", "emails": "value", "end_at": "2022-05-15 00:00:12", "format": 0, "frequency": "value", "last_run_at": "2022-05-15 00:17:07", "name": "value", "next_run_at": "2022-05-15 00:17:38", "report_id": 5208, "start_at": "2022-05-15 00:04:10", "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/30 HTTP/1.1 Host: l7api.com { "report_id": 355, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-03-06", "end_at": "2024-03-06", "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": 1221, "created_at": "2018-11-21 05:52:42", "culture": 1, "description": "value", "emails": "value", "end_at": "2018-11-21 05:48:28", "format": 0, "frequency": "value", "last_run_at": "2018-11-21 05:44:28", "name": "value", "next_run_at": "2018-11-21 05:44:19", "report_id": 9696, "start_at": "2018-11-21 05:44:45", "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/47 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": 9681, "created_at": "2020-12-10 06:00:29", "culture": 5, "description": "value", "emails": "value", "end_at": "2020-12-10 05:53:26", "format": 0, "frequency": "value", "last_run_at": "2020-12-10 06:00:53", "name": "value", "next_run_at": "2020-12-10 05:56:57", "report_id": 8055, "start_at": "2020-12-10 05:58:16", "status": 0, "timezone": "value" } ], "total": 59 }