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": 4205,
"created_at": "2025-07-01 05:16:34",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2025-07-01 05:07:37",
"format": 1,
"frequency": "value",
"last_run_at": "2025-07-01 05:06:26",
"name": "value",
"next_run_at": "2025-07-01 05:13:21",
"report_id": 9169,
"start_at": "2025-07-01 05:13:58",
"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": 108,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-23",
"end_at": "2026-06-23",
"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": 190,
"created_at": "2022-11-29 06:48:25",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2022-11-29 07:03:05",
"format": 0,
"frequency": "value",
"last_run_at": "2022-11-29 06:50:20",
"name": "value",
"next_run_at": "2022-11-29 06:57:18",
"report_id": 1748,
"start_at": "2022-11-29 07:05:08",
"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/26 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": 4383,
"created_at": "2019-08-17 08:24:37",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2019-08-17 08:12:56",
"format": 1,
"frequency": "value",
"last_run_at": "2019-08-17 08:19:53",
"name": "value",
"next_run_at": "2019-08-17 08:18:53",
"report_id": 8706,
"start_at": "2019-08-17 08:09:14",
"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/29 HTTP/1.1
Host: l7api.com
{
"report_id": 909,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-23",
"end_at": "2026-06-23",
"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": 7060,
"created_at": "2017-04-16 09:15:26",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2017-04-16 09:14:28",
"format": 1,
"frequency": "value",
"last_run_at": "2017-04-16 08:59:04",
"name": "value",
"next_run_at": "2017-04-16 09:10:50",
"report_id": 6171,
"start_at": "2017-04-16 09:13:58",
"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/44 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": 816,
"created_at": "2024-07-01 10:48:46",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2024-07-01 10:51:13",
"format": 1,
"frequency": "value",
"last_run_at": "2024-07-01 10:43:41",
"name": "value",
"next_run_at": "2024-07-01 10:47:35",
"report_id": 657,
"start_at": "2024-07-01 10:52:20",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}