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": 7091,
"created_at": "2019-10-07 20:31:03",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2019-10-07 20:37:08",
"format": 1,
"frequency": "value",
"last_run_at": "2019-10-07 20:23:29",
"name": "value",
"next_run_at": "2019-10-07 20:25:59",
"report_id": 3936,
"start_at": "2019-10-07 20:30:33",
"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": 884,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-01-22",
"end_at": "2026-01-22",
"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": 339,
"created_at": "2024-06-20 21:22:57",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2024-06-20 21:28:57",
"format": 0,
"frequency": "value",
"last_run_at": "2024-06-20 21:40:37",
"name": "value",
"next_run_at": "2024-06-20 21:23:22",
"report_id": 9182,
"start_at": "2024-06-20 21:39:18",
"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/8 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": 4983,
"created_at": "2024-02-16 06:54:25",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2024-02-16 06:54:19",
"format": 0,
"frequency": "value",
"last_run_at": "2024-02-16 06:55:26",
"name": "value",
"next_run_at": "2024-02-16 06:58:14",
"report_id": 7592,
"start_at": "2024-02-16 06:59:30",
"status": 0,
"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/58 HTTP/1.1
Host: l7api.com
{
"report_id": 871,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-01-22",
"end_at": "2026-01-22",
"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": 3481,
"created_at": "2025-02-22 20:00:11",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2025-02-22 19:49:23",
"format": 0,
"frequency": "value",
"last_run_at": "2025-02-22 19:46:42",
"name": "value",
"next_run_at": "2025-02-22 19:54:08",
"report_id": 9338,
"start_at": "2025-02-22 19:48:40",
"status": 0,
"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/33 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": 9343,
"created_at": "2018-05-13 02:35:34",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2018-05-13 02:32:16",
"format": 0,
"frequency": "value",
"last_run_at": "2018-05-13 02:34:54",
"name": "value",
"next_run_at": "2018-05-13 02:26:12",
"report_id": 1233,
"start_at": "2018-05-13 02:24:58",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}