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": 4610,
"created_at": "2021-10-15 16:37:48",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2021-10-15 16:41:44",
"format": 0,
"frequency": "value",
"last_run_at": "2021-10-15 16:43:50",
"name": "value",
"next_run_at": "2021-10-15 16:46:38",
"report_id": 4896,
"start_at": "2021-10-15 16:33:15",
"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
format string
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": 340,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-02",
"end_at": "2025-01-02",
"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": 442,
"created_at": "2018-09-27 17:33:16",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2018-09-27 17:20:27",
"format": 0,
"frequency": "value",
"last_run_at": "2018-09-27 17:28:24",
"name": "value",
"next_run_at": "2018-09-27 17:26:53",
"report_id": 1669,
"start_at": "2018-09-27 17:17:35",
"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/97 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": 7153,
"created_at": "2023-02-09 17:06:59",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2023-02-09 17:25:16",
"format": 1,
"frequency": "value",
"last_run_at": "2023-02-09 17:20:41",
"name": "value",
"next_run_at": "2023-02-09 17:18:08",
"report_id": 5533,
"start_at": "2023-02-09 17:19:36",
"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
format string
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/13 HTTP/1.1
Host: l7api.com
{
"report_id": 861,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-02",
"end_at": "2025-01-02",
"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": 7532,
"created_at": "2021-09-16 01:53:06",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2021-09-16 01:56:48",
"format": 1,
"frequency": "value",
"last_run_at": "2021-09-16 02:08:57",
"name": "value",
"next_run_at": "2021-09-16 02:01:48",
"report_id": 9258,
"start_at": "2021-09-16 01:54:57",
"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/20 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": 8667,
"created_at": "2023-07-28 03:55:59",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2023-07-28 03:55:25",
"format": 1,
"frequency": "value",
"last_run_at": "2023-07-28 03:48:42",
"name": "value",
"next_run_at": "2023-07-28 04:00:37",
"report_id": 5888,
"start_at": "2023-07-28 03:45:40",
"status": 1,
"timezone": "value"
}
],
"total": 59
}