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": 3930,
"created_at": "2019-10-04 17:11:10",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2019-10-04 17:15:46",
"format": 0,
"frequency": "value",
"last_run_at": "2019-10-04 17:09:48",
"name": "value",
"next_run_at": "2019-10-04 17:04:16",
"report_id": 3245,
"start_at": "2019-10-04 17:05: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": 652,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-11-13",
"end_at": "2025-11-13",
"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": 65,
"created_at": "2023-05-27 03:19:18",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2023-05-27 03:15:37",
"format": 1,
"frequency": "value",
"last_run_at": "2023-05-27 03:14:14",
"name": "value",
"next_run_at": "2023-05-27 03:18:52",
"report_id": 4511,
"start_at": "2023-05-27 03:17:57",
"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/76 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": 9848,
"created_at": "2020-04-08 18:47:20",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2020-04-08 18:47:38",
"format": 0,
"frequency": "value",
"last_run_at": "2020-04-08 18:58:22",
"name": "value",
"next_run_at": "2020-04-08 19:00:40",
"report_id": 4009,
"start_at": "2020-04-08 18:51:05",
"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/79 HTTP/1.1
Host: l7api.com
{
"report_id": 863,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-11-13",
"end_at": "2025-11-13",
"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": 7920,
"created_at": "2020-11-27 18:42:45",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2020-11-27 18:41:53",
"format": 0,
"frequency": "value",
"last_run_at": "2020-11-27 18:50:39",
"name": "value",
"next_run_at": "2020-11-27 18:43:42",
"report_id": 6737,
"start_at": "2020-11-27 18:37:23",
"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/21 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": 4436,
"created_at": "2023-11-12 12:35:32",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2023-11-12 12:34:29",
"format": 1,
"frequency": "value",
"last_run_at": "2023-11-12 12:32:50",
"name": "value",
"next_run_at": "2023-11-12 12:42:29",
"report_id": 5294,
"start_at": "2023-11-12 12:43:43",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}