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": 5499,
"created_at": "2021-10-30 11:21:37",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2021-10-30 11:30:11",
"format": 0,
"frequency": "value",
"last_run_at": "2021-10-30 11:26:54",
"name": "value",
"next_run_at": "2021-10-30 11:30:20",
"report_id": 3430,
"start_at": "2021-10-30 11:28:40",
"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": 186,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-10",
"end_at": "2026-06-10",
"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": 1099,
"created_at": "2022-11-24 22:21:44",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2022-11-24 22:16:54",
"format": 0,
"frequency": "value",
"last_run_at": "2022-11-24 22:22:54",
"name": "value",
"next_run_at": "2022-11-24 22:24:39",
"report_id": 1045,
"start_at": "2022-11-24 22:17:55",
"status": 1,
"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/16 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": 9043,
"created_at": "2023-08-17 06:35:49",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2023-08-17 06:17:28",
"format": 0,
"frequency": "value",
"last_run_at": "2023-08-17 06:18:10",
"name": "value",
"next_run_at": "2023-08-17 06:20:41",
"report_id": 918,
"start_at": "2023-08-17 06:27:45",
"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/18 HTTP/1.1
Host: l7api.com
{
"report_id": 221,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-06-10",
"end_at": "2026-06-10",
"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": 5326,
"created_at": "2021-03-02 11:50:18",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2021-03-02 12:01:04",
"format": 1,
"frequency": "value",
"last_run_at": "2021-03-02 11:53:24",
"name": "value",
"next_run_at": "2021-03-02 12:02:37",
"report_id": 3085,
"start_at": "2021-03-02 11:42:57",
"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/47 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": 6917,
"created_at": "2021-07-30 01:23:42",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2021-07-30 01:18:09",
"format": 1,
"frequency": "value",
"last_run_at": "2021-07-30 01:18:28",
"name": "value",
"next_run_at": "2021-07-30 01:17:57",
"report_id": 2742,
"start_at": "2021-07-30 01:29:33",
"status": 0,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}