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": 1260, "created_at": "2020-04-25 06:08:52", "culture": 6, "description": "value", "emails": "value", "end_at": "2020-04-25 06:05:11", "format": 0, "frequency": "value", "last_run_at": "2020-04-25 05:53:46", "name": "value", "next_run_at": "2020-04-25 05:59:59", "report_id": 4729, "start_at": "2020-04-25 06:11:39", "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": 976, "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": 8265, "created_at": "2016-11-30 10:43:23", "culture": 3, "description": "value", "emails": "value", "end_at": "2016-11-30 10:43:57", "format": 0, "frequency": "value", "last_run_at": "2016-11-30 10:48:55", "name": "value", "next_run_at": "2016-11-30 10:59:12", "report_id": 300, "start_at": "2016-11-30 11:00:09", "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/65 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": 6882, "created_at": "2023-06-22 20:26:32", "culture": 2, "description": "value", "emails": "value", "end_at": "2023-06-22 20:34:49", "format": 0, "frequency": "value", "last_run_at": "2023-06-22 20:30:31", "name": "value", "next_run_at": "2023-06-22 20:22:48", "report_id": 8494, "start_at": "2023-06-22 20:30:28", "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/31 HTTP/1.1 Host: l7api.com { "report_id": 170, "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": 202, "created_at": "2018-06-02 21:42:05", "culture": 4, "description": "value", "emails": "value", "end_at": "2018-06-02 21:46:31", "format": 0, "frequency": "value", "last_run_at": "2018-06-02 21:54:25", "name": "value", "next_run_at": "2018-06-02 21:52:57", "report_id": 2773, "start_at": "2018-06-02 21:52:22", "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/33 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": 8868, "created_at": "2018-08-28 20:11:23", "culture": 6, "description": "value", "emails": "value", "end_at": "2018-08-28 20:30:11", "format": 0, "frequency": "value", "last_run_at": "2018-08-28 20:20:03", "name": "value", "next_run_at": "2018-08-28 20:20:23", "report_id": 5452, "start_at": "2018-08-28 20:12:51", "status": 1, "timezone": "value" } ], "total": 59 }