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": 5765,
"created_at": "2018-02-08 12:52:31",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2018-02-08 12:46:40",
"format": 1,
"frequency": "value",
"last_run_at": "2018-02-08 12:41:31",
"name": "value",
"next_run_at": "2018-02-08 12:45:59",
"report_id": 414,
"start_at": "2018-02-08 12:47:21",
"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": 795,
"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": 1041,
"created_at": "2017-05-24 21:28:27",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2017-05-24 21:26:20",
"format": 0,
"frequency": "value",
"last_run_at": "2017-05-24 21:15:16",
"name": "value",
"next_run_at": "2017-05-24 21:18:00",
"report_id": 3496,
"start_at": "2017-05-24 21:31:54",
"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/46 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": 1498,
"created_at": "2016-08-30 22:55:04",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2016-08-30 23:03:58",
"format": 0,
"frequency": "value",
"last_run_at": "2016-08-30 22:55:32",
"name": "value",
"next_run_at": "2016-08-30 23:08:14",
"report_id": 4896,
"start_at": "2016-08-30 23:04:54",
"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/70 HTTP/1.1
Host: l7api.com
{
"report_id": 436,
"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": 3114,
"created_at": "2023-11-01 02:25:24",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2023-11-01 02:24:34",
"format": 0,
"frequency": "value",
"last_run_at": "2023-11-01 02:25:51",
"name": "value",
"next_run_at": "2023-11-01 02:40:55",
"report_id": 9307,
"start_at": "2023-11-01 02:38:21",
"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/20 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": 5453,
"created_at": "2022-05-23 11:49:30",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2022-05-23 12:00:25",
"format": 0,
"frequency": "value",
"last_run_at": "2022-05-23 11:56:11",
"name": "value",
"next_run_at": "2022-05-23 12:04:26",
"report_id": 5640,
"start_at": "2022-05-23 12:01:37",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}