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": 4392,
"created_at": "2019-01-30 18:27:47",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2019-01-30 18:31:33",
"format": 1,
"frequency": "value",
"last_run_at": "2019-01-30 18:24:02",
"name": "value",
"next_run_at": "2019-01-30 18:20:30",
"report_id": 2057,
"start_at": "2019-01-30 18:15:20",
"status": 1,
"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": 780,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-23",
"end_at": "2026-06-23",
"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": 7246,
"created_at": "2023-05-21 17:48:39",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2023-05-21 17:49:03",
"format": 0,
"frequency": "value",
"last_run_at": "2023-05-21 17:41:55",
"name": "value",
"next_run_at": "2023-05-21 17:47:37",
"report_id": 9300,
"start_at": "2023-05-21 17:50:00",
"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/20 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": 6647,
"created_at": "2023-08-18 11:03:47",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2023-08-18 10:52:47",
"format": 1,
"frequency": "value",
"last_run_at": "2023-08-18 10:58:43",
"name": "value",
"next_run_at": "2023-08-18 10:54:19",
"report_id": 4378,
"start_at": "2023-08-18 11:07:55",
"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/27 HTTP/1.1
Host: l7api.com
{
"report_id": 139,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-23",
"end_at": "2026-06-23",
"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": 9171,
"created_at": "2020-12-26 11:41:34",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2020-12-26 11:43:01",
"format": 1,
"frequency": "value",
"last_run_at": "2020-12-26 11:43:03",
"name": "value",
"next_run_at": "2020-12-26 11:47:43",
"report_id": 953,
"start_at": "2020-12-26 11:40:12",
"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/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": 19,
"created_at": "2024-11-16 05:14:14",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2024-11-16 05:13:16",
"format": 0,
"frequency": "value",
"last_run_at": "2024-11-16 05:14:00",
"name": "value",
"next_run_at": "2024-11-16 05:19:39",
"report_id": 1058,
"start_at": "2024-11-16 05:23:19",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}