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": 9079,
"created_at": "2025-04-04 00:39:56",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2025-04-04 00:42:21",
"format": 1,
"frequency": "value",
"last_run_at": "2025-04-04 00:57:20",
"name": "value",
"next_run_at": "2025-04-04 00:38:50",
"report_id": 2424,
"start_at": "2025-04-04 00:47:56",
"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": 563,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-05-07",
"end_at": "2026-05-07",
"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": 617,
"created_at": "2024-05-26 21:21:08",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2024-05-26 21:19:36",
"format": 0,
"frequency": "value",
"last_run_at": "2024-05-26 21:29:55",
"name": "value",
"next_run_at": "2024-05-26 21:13:24",
"report_id": 748,
"start_at": "2024-05-26 21:21:26",
"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/19 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": 2802,
"created_at": "2019-04-07 08:26:16",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2019-04-07 08:40:10",
"format": 0,
"frequency": "value",
"last_run_at": "2019-04-07 08:31:42",
"name": "value",
"next_run_at": "2019-04-07 08:41:21",
"report_id": 5751,
"start_at": "2019-04-07 08:45:40",
"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/78 HTTP/1.1
Host: l7api.com
{
"report_id": 422,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-05-07",
"end_at": "2026-05-07",
"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": 6061,
"created_at": "2025-11-16 10:14:13",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2025-11-16 10:27:05",
"format": 1,
"frequency": "value",
"last_run_at": "2025-11-16 10:16:14",
"name": "value",
"next_run_at": "2025-11-16 10:23:15",
"report_id": 7390,
"start_at": "2025-11-16 10:21:27",
"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/19 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": 5708,
"created_at": "2021-12-02 08:41:40",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2021-12-02 08:27:53",
"format": 0,
"frequency": "value",
"last_run_at": "2021-12-02 08:25:29",
"name": "value",
"next_run_at": "2021-12-02 08:31:36",
"report_id": 1419,
"start_at": "2021-12-02 08:41:08",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}