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": 2935,
"created_at": "2021-11-20 20:36:14",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2021-11-20 20:38:42",
"format": 0,
"frequency": "value",
"last_run_at": "2021-11-20 20:41:04",
"name": "value",
"next_run_at": "2021-11-20 20:52:26",
"report_id": 1318,
"start_at": "2021-11-20 20:50:56",
"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": 890,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-08-12",
"end_at": "2026-08-12",
"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": 5860,
"created_at": "2025-01-27 01:53:38",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2025-01-27 01:56:00",
"format": 1,
"frequency": "value",
"last_run_at": "2025-01-27 01:59:24",
"name": "value",
"next_run_at": "2025-01-27 01:49:19",
"report_id": 5714,
"start_at": "2025-01-27 01:50:20",
"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/9 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": 1174,
"created_at": "2016-05-07 06:31:01",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2016-05-07 06:30:53",
"format": 1,
"frequency": "value",
"last_run_at": "2016-05-07 06:29:02",
"name": "value",
"next_run_at": "2016-05-07 06:17:56",
"report_id": 2703,
"start_at": "2016-05-07 06:27:00",
"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/74 HTTP/1.1
Host: l7api.com
{
"report_id": 424,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-08-12",
"end_at": "2026-08-12",
"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": 1064,
"created_at": "2023-05-05 07:23:08",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2023-05-05 07:21:43",
"format": 1,
"frequency": "value",
"last_run_at": "2023-05-05 07:19:41",
"name": "value",
"next_run_at": "2023-05-05 07:32:17",
"report_id": 2930,
"start_at": "2023-05-05 07:31:41",
"status": 1,
"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/13 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": 984,
"created_at": "2017-02-12 18:22:37",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2017-02-12 18:35:25",
"format": 0,
"frequency": "value",
"last_run_at": "2017-02-12 18:30:47",
"name": "value",
"next_run_at": "2017-02-12 18:26:39",
"report_id": 4109,
"start_at": "2017-02-12 18:32:30",
"status": 0,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}