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": 8645,
"created_at": "2023-02-12 15:27:32",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2023-02-12 15:14:11",
"format": 0,
"frequency": "value",
"last_run_at": "2023-02-12 15:26:31",
"name": "value",
"next_run_at": "2023-02-12 15:28:04",
"report_id": 3215,
"start_at": "2023-02-12 15:22:09",
"status": 0,
"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": 889,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-01-22",
"end_at": "2026-01-22",
"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": 4704,
"created_at": "2023-09-03 04:07:37",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2023-09-03 03:59:22",
"format": 0,
"frequency": "value",
"last_run_at": "2023-09-03 04:02:40",
"name": "value",
"next_run_at": "2023-09-03 04:01:36",
"report_id": 2233,
"start_at": "2023-09-03 04:12:00",
"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/40 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": 5108,
"created_at": "2020-04-21 14:10:21",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2020-04-21 14:20:25",
"format": 0,
"frequency": "value",
"last_run_at": "2020-04-21 14:06:26",
"name": "value",
"next_run_at": "2020-04-21 14:17:24",
"report_id": 4465,
"start_at": "2020-04-21 14:13:52",
"status": 1,
"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/38 HTTP/1.1
Host: l7api.com
{
"report_id": 316,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-01-22",
"end_at": "2026-01-22",
"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": 5232,
"created_at": "2025-11-27 09:07:24",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2025-11-27 09:15:34",
"format": 0,
"frequency": "value",
"last_run_at": "2025-11-27 09:14:33",
"name": "value",
"next_run_at": "2025-11-27 08:57:37",
"report_id": 4080,
"start_at": "2025-11-27 08:58:21",
"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/21 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": 281,
"created_at": "2017-10-12 11:01:42",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2017-10-12 11:07:50",
"format": 1,
"frequency": "value",
"last_run_at": "2017-10-12 10:57:14",
"name": "value",
"next_run_at": "2017-10-12 10:53:17",
"report_id": 3492,
"start_at": "2017-10-12 11:06:28",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}