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": 7735,
"created_at": "2020-06-01 23:04:22",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2020-06-01 23:10:59",
"format": 0,
"frequency": "value",
"last_run_at": "2020-06-01 22:59:58",
"name": "value",
"next_run_at": "2020-06-01 23:10:12",
"report_id": 457,
"start_at": "2020-06-01 23:03:53",
"status": 0,
"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": 119,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-07-16",
"end_at": "2025-07-16",
"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": 2410,
"created_at": "2023-06-09 22:47:55",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2023-06-09 22:58:14",
"format": 0,
"frequency": "value",
"last_run_at": "2023-06-09 22:48:57",
"name": "value",
"next_run_at": "2023-06-09 22:57:07",
"report_id": 5861,
"start_at": "2023-06-09 22:47:59",
"status": 1,
"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/78 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": 1248,
"created_at": "2022-10-06 14:19:51",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2022-10-06 14:12:54",
"format": 0,
"frequency": "value",
"last_run_at": "2022-10-06 14:09:48",
"name": "value",
"next_run_at": "2022-10-06 14:27:32",
"report_id": 5766,
"start_at": "2022-10-06 14:25:49",
"status": 0,
"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/30 HTTP/1.1
Host: l7api.com
{
"report_id": 349,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-07-16",
"end_at": "2025-07-16",
"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": 300,
"created_at": "2024-07-26 14:51:16",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2024-07-26 15:04:43",
"format": 1,
"frequency": "value",
"last_run_at": "2024-07-26 14:50:03",
"name": "value",
"next_run_at": "2024-07-26 15:00:50",
"report_id": 1937,
"start_at": "2024-07-26 14:57:39",
"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/52 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": 8046,
"created_at": "2023-10-16 14:16:04",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2023-10-16 14:11:24",
"format": 1,
"frequency": "value",
"last_run_at": "2023-10-16 14:15:10",
"name": "value",
"next_run_at": "2023-10-16 14:14:12",
"report_id": 4181,
"start_at": "2023-10-16 14:16:18",
"status": 0,
"timezone": "value"
}
],
"total": 59
}