Reports module
Endpoints
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": 6612, "created_at": "2023-03-18 12:29:07", "culture": 7, "description": "value", "emails": "value", "end_at": "2023-03-18 12:41:50", "format": 1, "frequency": "value", "last_run_at": "2023-03-18 12:38:05", "name": "value", "next_run_at": "2023-03-18 12:30:21", "report_id": 7515, "start_at": "2023-03-18 12:29:01", "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": 485, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-12-03", "end_at": "2024-12-03", "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": 8374, "created_at": "2018-04-17 00:06:58", "culture": 4, "description": "value", "emails": "value", "end_at": "2018-04-17 00:22:42", "format": 0, "frequency": "value", "last_run_at": "2018-04-17 00:14:36", "name": "value", "next_run_at": "2018-04-17 00:19:42", "report_id": 5379, "start_at": "2018-04-17 00:05:34", "status": 0, "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/35 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": 9726, "created_at": "2018-02-17 03:02:31", "culture": 3, "description": "value", "emails": "value", "end_at": "2018-02-17 02:53:24", "format": 1, "frequency": "value", "last_run_at": "2018-02-17 03:02:16", "name": "value", "next_run_at": "2018-02-17 02:57:13", "report_id": 6346, "start_at": "2018-02-17 03:06:51", "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/97 HTTP/1.1 Host: l7api.com { "report_id": 690, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-12-03", "end_at": "2024-12-03", "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": 375, "created_at": "2017-01-26 04:49:37", "culture": 3, "description": "value", "emails": "value", "end_at": "2017-01-26 04:51:14", "format": 0, "frequency": "value", "last_run_at": "2017-01-26 05:01:54", "name": "value", "next_run_at": "2017-01-26 04:57:08", "report_id": 3795, "start_at": "2017-01-26 04:51:19", "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/57 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": 6192, "created_at": "2020-09-01 10:24:09", "culture": 6, "description": "value", "emails": "value", "end_at": "2020-09-01 10:16:19", "format": 0, "frequency": "value", "last_run_at": "2020-09-01 10:18:10", "name": "value", "next_run_at": "2020-09-01 10:21:21", "report_id": 6057, "start_at": "2020-09-01 10:26:05", "status": 1, "timezone": "value" } ], "total": 59 }