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": 734, "created_at": "2016-12-04 15:56:03", "culture": 3, "description": "value", "emails": "value", "end_at": "2016-12-04 15:47:17", "format": 0, "frequency": "value", "last_run_at": "2016-12-04 15:45:32", "name": "value", "next_run_at": "2016-12-04 15:46:39", "report_id": 9951, "start_at": "2016-12-04 15:40:36", "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": 601, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-08-06", "end_at": "2024-08-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": 4833, "created_at": "2022-01-15 04:47:00", "culture": 0, "description": "value", "emails": "value", "end_at": "2022-01-15 04:46:04", "format": 0, "frequency": "value", "last_run_at": "2022-01-15 04:47:43", "name": "value", "next_run_at": "2022-01-15 04:46:35", "report_id": 8772, "start_at": "2022-01-15 04:46:48", "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/99 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": 8042, "created_at": "2022-04-14 11:11:21", "culture": 0, "description": "value", "emails": "value", "end_at": "2022-04-14 11:10:29", "format": 0, "frequency": "value", "last_run_at": "2022-04-14 11:01:20", "name": "value", "next_run_at": "2022-04-14 11:00:56", "report_id": 9062, "start_at": "2022-04-14 11:09:09", "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/52 HTTP/1.1 Host: l7api.com { "report_id": 812, "name": "abcd", "description": "abcd", "emails": [ "john@example.com", "mike@w3c.com" ], "culture": "abcd", "start_at": "2024-08-06", "end_at": "2024-08-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": 6395, "created_at": "2019-05-17 12:28:56", "culture": 7, "description": "value", "emails": "value", "end_at": "2019-05-17 12:33:57", "format": 0, "frequency": "value", "last_run_at": "2019-05-17 12:17:30", "name": "value", "next_run_at": "2019-05-17 12:17:50", "report_id": 2182, "start_at": "2019-05-17 12:18:19", "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/65 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": 1932, "created_at": "2017-11-28 14:02:16", "culture": 6, "description": "value", "emails": "value", "end_at": "2017-11-28 14:08:00", "format": 0, "frequency": "value", "last_run_at": "2017-11-28 14:11:09", "name": "value", "next_run_at": "2017-11-28 14:02:49", "report_id": 7601, "start_at": "2017-11-28 14:11:06", "status": 0, "timezone": "value" } ], "total": 59 }