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": 8440,
"created_at": "2016-05-24 04:42:51",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2016-05-24 04:31:17",
"format": 1,
"frequency": "value",
"last_run_at": "2016-05-24 04:30:37",
"name": "value",
"next_run_at": "2016-05-24 04:47:44",
"report_id": 1897,
"start_at": "2016-05-24 04:33:24",
"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": 299,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-10-28",
"end_at": "2025-10-28",
"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": 5896,
"created_at": "2025-05-30 10:25:37",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2025-05-30 10:29:28",
"format": 1,
"frequency": "value",
"last_run_at": "2025-05-30 10:25:15",
"name": "value",
"next_run_at": "2025-05-30 10:23:53",
"report_id": 4060,
"start_at": "2025-05-30 10:23:37",
"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/67 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": 9722,
"created_at": "2018-06-28 06:19:11",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2018-06-28 06:15:07",
"format": 0,
"frequency": "value",
"last_run_at": "2018-06-28 06:18:21",
"name": "value",
"next_run_at": "2018-06-28 06:25:30",
"report_id": 7888,
"start_at": "2018-06-28 06:12:44",
"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/12 HTTP/1.1
Host: l7api.com
{
"report_id": 972,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-10-28",
"end_at": "2025-10-28",
"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": 486,
"created_at": "2023-02-06 20:14:35",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2023-02-06 20:25:05",
"format": 0,
"frequency": "value",
"last_run_at": "2023-02-06 20:21:43",
"name": "value",
"next_run_at": "2023-02-06 20:10:41",
"report_id": 9130,
"start_at": "2023-02-06 20:21:32",
"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/67 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": 5692,
"created_at": "2019-01-08 04:20:13",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2019-01-08 04:27:55",
"format": 1,
"frequency": "value",
"last_run_at": "2019-01-08 04:21:38",
"name": "value",
"next_run_at": "2019-01-08 04:27:49",
"report_id": 7264,
"start_at": "2019-01-08 04:32:07",
"status": 0,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}