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": 7069,
"created_at": "2023-03-14 19:58:42",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2023-03-14 20:05:47",
"format": 0,
"frequency": "value",
"last_run_at": "2023-03-14 20:06:55",
"name": "value",
"next_run_at": "2023-03-14 20:02:52",
"report_id": 3369,
"start_at": "2023-03-14 20:05:41",
"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": 750,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 9960,
"created_at": "2018-09-27 16:31:01",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2018-09-27 16:16:57",
"format": 0,
"frequency": "value",
"last_run_at": "2018-09-27 16:15:51",
"name": "value",
"next_run_at": "2018-09-27 16:25:32",
"report_id": 2502,
"start_at": "2018-09-27 16:28:45",
"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/41 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": 3415,
"created_at": "2024-01-04 20:59:21",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2024-01-04 20:58:27",
"format": 0,
"frequency": "value",
"last_run_at": "2024-01-04 21:13:37",
"name": "value",
"next_run_at": "2024-01-04 21:10:23",
"report_id": 1036,
"start_at": "2024-01-04 21:14:12",
"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/90 HTTP/1.1
Host: l7api.com
{
"report_id": 938,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 3754,
"created_at": "2024-07-13 12:05:16",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2024-07-13 11:58:08",
"format": 0,
"frequency": "value",
"last_run_at": "2024-07-13 11:48:01",
"name": "value",
"next_run_at": "2024-07-13 11:49:17",
"report_id": 9439,
"start_at": "2024-07-13 12:01:37",
"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/94 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": 6270,
"created_at": "2023-01-16 10:10:24",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2023-01-16 10:10:18",
"format": 0,
"frequency": "value",
"last_run_at": "2023-01-16 09:57:37",
"name": "value",
"next_run_at": "2023-01-16 10:02:59",
"report_id": 5323,
"start_at": "2023-01-16 10:01:23",
"status": 1,
"timezone": "value"
}
],
"total": 59
}