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": 1336,
"created_at": "2016-05-30 02:42:42",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2016-05-30 02:42:25",
"format": 0,
"frequency": "value",
"last_run_at": "2016-05-30 02:44:35",
"name": "value",
"next_run_at": "2016-05-30 02:41:47",
"report_id": 7556,
"start_at": "2016-05-30 02:48:31",
"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": 415,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-07-16",
"end_at": "2025-07-16",
"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": 5366,
"created_at": "2017-10-05 03:08:00",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2017-10-05 03:07:57",
"format": 0,
"frequency": "value",
"last_run_at": "2017-10-05 03:04:43",
"name": "value",
"next_run_at": "2017-10-05 03:11:45",
"report_id": 2087,
"start_at": "2017-10-05 03:14:46",
"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/79 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": 9075,
"created_at": "2024-01-19 06:35:39",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2024-01-19 06:34:23",
"format": 0,
"frequency": "value",
"last_run_at": "2024-01-19 06:35:20",
"name": "value",
"next_run_at": "2024-01-19 06:37:44",
"report_id": 9816,
"start_at": "2024-01-19 06:42:29",
"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/84 HTTP/1.1
Host: l7api.com
{
"report_id": 524,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-07-16",
"end_at": "2025-07-16",
"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": 7089,
"created_at": "2021-08-22 21:09:23",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2021-08-22 21:02:48",
"format": 0,
"frequency": "value",
"last_run_at": "2021-08-22 21:11:07",
"name": "value",
"next_run_at": "2021-08-22 21:10:16",
"report_id": 4938,
"start_at": "2021-08-22 21:06:36",
"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/73 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": 9986,
"created_at": "2025-01-03 02:30:16",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2025-01-03 02:29:33",
"format": 0,
"frequency": "value",
"last_run_at": "2025-01-03 02:23:54",
"name": "value",
"next_run_at": "2025-01-03 02:21:54",
"report_id": 5836,
"start_at": "2025-01-03 02:34:33",
"status": 1,
"timezone": "value"
}
],
"total": 59
}