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": 2288,
"created_at": "2017-12-26 20:09:54",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2017-12-26 20:15:14",
"format": 0,
"frequency": "value",
"last_run_at": "2017-12-26 20:06:13",
"name": "value",
"next_run_at": "2017-12-26 20:15:34",
"report_id": 4221,
"start_at": "2017-12-26 20:08:32",
"status": 1,
"timezone": "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
timezone string
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1
Host: l7api.com
{
"report_id": 926,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-10-07",
"end_at": "2025-10-07",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"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": 3424,
"created_at": "2016-05-13 01:15:07",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2016-05-13 01:09:08",
"format": 0,
"frequency": "value",
"last_run_at": "2016-05-13 01:14:48",
"name": "value",
"next_run_at": "2016-05-13 01:19:41",
"report_id": 3814,
"start_at": "2016-05-13 01:20:17",
"status": 0,
"timezone": "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/91 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": 3706,
"created_at": "2021-11-21 09:09:15",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2021-11-21 09:14:11",
"format": 0,
"frequency": "value",
"last_run_at": "2021-11-21 08:59:21",
"name": "value",
"next_run_at": "2021-11-21 09:10:36",
"report_id": 148,
"start_at": "2021-11-21 09:07:15",
"status": 1,
"timezone": "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
timezone string
Example Request
PATCH /v1.1/voipstudio/reportschedules/62 HTTP/1.1
Host: l7api.com
{
"report_id": 876,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-10-07",
"end_at": "2025-10-07",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"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": 3350,
"created_at": "2017-10-31 10:27:44",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2017-10-31 10:24:15",
"format": 0,
"frequency": "value",
"last_run_at": "2017-10-31 10:11:41",
"name": "value",
"next_run_at": "2017-10-31 10:14:27",
"report_id": 4982,
"start_at": "2017-10-31 10:12:58",
"status": 1,
"timezone": "value"
},
"links": {}
}
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/77 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": 6303,
"created_at": "2023-10-24 05:54:00",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2023-10-24 06:02:59",
"format": 0,
"frequency": "value",
"last_run_at": "2023-10-24 05:56:15",
"name": "value",
"next_run_at": "2023-10-24 06:09:41",
"report_id": 8483,
"start_at": "2023-10-24 05:52:41",
"status": 1,
"timezone": "value"
}
],
"total": 59
}