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": 7340,
"created_at": "2026-07-20 03:14:44",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2026-07-20 03:16:50",
"format": 1,
"frequency": "value",
"last_run_at": "2026-07-20 03:16:21",
"name": "value",
"next_run_at": "2026-07-20 03:19:21",
"report_id": 262,
"start_at": "2026-07-20 03:19:42",
"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": 287,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-08-12",
"end_at": "2026-08-12",
"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": 779,
"created_at": "2024-04-28 13:33:12",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2024-04-28 13:18:14",
"format": 1,
"frequency": "value",
"last_run_at": "2024-04-28 13:30:18",
"name": "value",
"next_run_at": "2024-04-28 13:26:10",
"report_id": 4133,
"start_at": "2024-04-28 13:35:33",
"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/92 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": 3161,
"created_at": "2016-05-21 13:59:37",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2016-05-21 13:56:38",
"format": 1,
"frequency": "value",
"last_run_at": "2016-05-21 14:04:09",
"name": "value",
"next_run_at": "2016-05-21 13:58:43",
"report_id": 1152,
"start_at": "2016-05-21 14:05:57",
"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/34 HTTP/1.1
Host: l7api.com
{
"report_id": 792,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-08-12",
"end_at": "2026-08-12",
"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": 9149,
"created_at": "2019-03-12 22:33:27",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2019-03-12 22:38:19",
"format": 0,
"frequency": "value",
"last_run_at": "2019-03-12 22:39:52",
"name": "value",
"next_run_at": "2019-03-12 22:21:46",
"report_id": 6831,
"start_at": "2019-03-12 22:21:50",
"status": 0,
"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/11 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": 2385,
"created_at": "2017-08-11 12:57:06",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2017-08-11 12:49:32",
"format": 0,
"frequency": "value",
"last_run_at": "2017-08-11 12:47:32",
"name": "value",
"next_run_at": "2017-08-11 12:56:56",
"report_id": 1462,
"start_at": "2017-08-11 12:56:17",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}