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": 9931,
"created_at": "2019-11-02 17:32:57",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2019-11-02 17:44:52",
"format": 1,
"frequency": "value",
"last_run_at": "2019-11-02 17:41:15",
"name": "value",
"next_run_at": "2019-11-02 17:44:36",
"report_id": 4215,
"start_at": "2019-11-02 17:31:30",
"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": 533,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-03",
"end_at": "2026-06-03",
"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": 1615,
"created_at": "2020-10-10 16:30:59",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2020-10-10 16:33:31",
"format": 0,
"frequency": "value",
"last_run_at": "2020-10-10 16:30:16",
"name": "value",
"next_run_at": "2020-10-10 16:22:55",
"report_id": 5106,
"start_at": "2020-10-10 16:30:29",
"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/22 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": 4733,
"created_at": "2024-05-09 10:18:47",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2024-05-09 10:10:44",
"format": 1,
"frequency": "value",
"last_run_at": "2024-05-09 10:06:20",
"name": "value",
"next_run_at": "2024-05-09 10:19:07",
"report_id": 4468,
"start_at": "2024-05-09 10:06:23",
"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/75 HTTP/1.1
Host: l7api.com
{
"report_id": 255,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-03",
"end_at": "2026-06-03",
"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": 5968,
"created_at": "2020-05-30 02:18:24",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2020-05-30 02:22:56",
"format": 0,
"frequency": "value",
"last_run_at": "2020-05-30 02:15:24",
"name": "value",
"next_run_at": "2020-05-30 02:10:39",
"report_id": 1589,
"start_at": "2020-05-30 02:17:09",
"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/88 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": 8010,
"created_at": "2017-06-13 23:06:53",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2017-06-13 22:49:09",
"format": 1,
"frequency": "value",
"last_run_at": "2017-06-13 22:51:04",
"name": "value",
"next_run_at": "2017-06-13 22:58:57",
"report_id": 8882,
"start_at": "2017-06-13 23:00:38",
"status": 0,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}