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": 6950,
"created_at": "2026-01-25 02:46:41",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2026-01-25 02:47:10",
"format": 0,
"frequency": "value",
"last_run_at": "2026-01-25 02:35:04",
"name": "value",
"next_run_at": "2026-01-25 02:44:05",
"report_id": 9981,
"start_at": "2026-01-25 02:46:02",
"status": 1,
"timezone": "value",
"tz": "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
tz string
timezone string
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1
Host: l7api.com
{
"report_id": 706,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-09-03",
"end_at": "2026-09-03",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"tz": "abcd",
"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": 1520,
"created_at": "2026-02-05 12:37:17",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2026-02-05 12:27:33",
"format": 0,
"frequency": "value",
"last_run_at": "2026-02-05 12:34:02",
"name": "value",
"next_run_at": "2026-02-05 12:41:44",
"report_id": 4522,
"start_at": "2026-02-05 12:41:13",
"status": 1,
"timezone": "value",
"tz": "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/84 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": 4461,
"created_at": "2021-12-03 14:08:48",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2021-12-03 14:07:42",
"format": 0,
"frequency": "value",
"last_run_at": "2021-12-03 13:54:59",
"name": "value",
"next_run_at": "2021-12-03 14:06:46",
"report_id": 3807,
"start_at": "2021-12-03 14:10:21",
"status": 0,
"timezone": "value",
"tz": "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
tz string
timezone string
Example Request
PATCH /v1.1/voipstudio/reportschedules/78 HTTP/1.1
Host: l7api.com
{
"report_id": 963,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-09-03",
"end_at": "2026-09-03",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"tz": "abcd",
"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": 253,
"created_at": "2023-02-01 23:06:08",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2023-02-01 23:04:21",
"format": 1,
"frequency": "value",
"last_run_at": "2023-02-01 23:10:34",
"name": "value",
"next_run_at": "2023-02-01 22:59:35",
"report_id": 7932,
"start_at": "2023-02-01 23:02:48",
"status": 1,
"timezone": "value",
"tz": "value"
},
"links": {}
}
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/76 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": 9571,
"created_at": "2024-12-19 11:31:51",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2024-12-19 11:26:06",
"format": 1,
"frequency": "value",
"last_run_at": "2024-12-19 11:34:51",
"name": "value",
"next_run_at": "2024-12-19 11:39:17",
"report_id": 4180,
"start_at": "2024-12-19 11:23:19",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}