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": 9336,
"created_at": "2018-05-24 17:48:13",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2018-05-24 17:57:35",
"format": 1,
"frequency": "value",
"last_run_at": "2018-05-24 17:51:45",
"name": "value",
"next_run_at": "2018-05-24 17:58:33",
"report_id": 6078,
"start_at": "2018-05-24 17:46:18",
"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": 605,
"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": 9618,
"created_at": "2020-03-15 04:02:56",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2020-03-15 03:52:31",
"format": 0,
"frequency": "value",
"last_run_at": "2020-03-15 03:56:45",
"name": "value",
"next_run_at": "2020-03-15 03:58:20",
"report_id": 4546,
"start_at": "2020-03-15 03:53:06",
"status": 0,
"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/36 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": 3020,
"created_at": "2023-02-19 10:33:02",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2023-02-19 10:42:54",
"format": 0,
"frequency": "value",
"last_run_at": "2023-02-19 10:39:11",
"name": "value",
"next_run_at": "2023-02-19 10:46:01",
"report_id": 4191,
"start_at": "2023-02-19 10:35:39",
"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/76 HTTP/1.1
Host: l7api.com
{
"report_id": 411,
"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": 983,
"created_at": "2025-08-06 06:19:33",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2025-08-06 06:20:47",
"format": 1,
"frequency": "value",
"last_run_at": "2025-08-06 06:12:15",
"name": "value",
"next_run_at": "2025-08-06 06:10:08",
"report_id": 1596,
"start_at": "2025-08-06 06:17:47",
"status": 1,
"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/34 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": 8432,
"created_at": "2019-01-09 23:21:17",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2019-01-09 23:31:49",
"format": 1,
"frequency": "value",
"last_run_at": "2019-01-09 23:39:40",
"name": "value",
"next_run_at": "2019-01-09 23:32:04",
"report_id": 5550,
"start_at": "2019-01-09 23:33:13",
"status": 0,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}