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": 6682,
"created_at": "2021-04-19 23:57:02",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2021-04-19 23:54:58",
"format": 1,
"frequency": "value",
"last_run_at": "2021-04-19 23:54:54",
"name": "value",
"next_run_at": "2021-04-19 23:58:31",
"report_id": 1209,
"start_at": "2021-04-19 23:54:05",
"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": 649,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-09-07",
"end_at": "2026-09-07",
"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": 4955,
"created_at": "2023-03-16 11:00:39",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2023-03-16 11:01:22",
"format": 0,
"frequency": "value",
"last_run_at": "2023-03-16 10:53:35",
"name": "value",
"next_run_at": "2023-03-16 10:53:50",
"report_id": 1623,
"start_at": "2023-03-16 10:54:58",
"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/65 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": 9818,
"created_at": "2019-12-20 07:46:38",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2019-12-20 07:41:29",
"format": 1,
"frequency": "value",
"last_run_at": "2019-12-20 07:43:35",
"name": "value",
"next_run_at": "2019-12-20 07:31:30",
"report_id": 1340,
"start_at": "2019-12-20 07:48:35",
"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/67 HTTP/1.1
Host: l7api.com
{
"report_id": 994,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2026-09-07",
"end_at": "2026-09-07",
"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": 4012,
"created_at": "2021-03-28 14:08:44",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2021-03-28 13:57:37",
"format": 0,
"frequency": "value",
"last_run_at": "2021-03-28 14:13:44",
"name": "value",
"next_run_at": "2021-03-28 14:05:46",
"report_id": 5196,
"start_at": "2021-03-28 14:00:20",
"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/34 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": 6753,
"created_at": "2023-01-15 09:08:07",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2023-01-15 09:04:44",
"format": 1,
"frequency": "value",
"last_run_at": "2023-01-15 08:58:58",
"name": "value",
"next_run_at": "2023-01-15 09:15:11",
"report_id": 5464,
"start_at": "2023-01-15 09:10:38",
"status": 1,
"timezone": "value",
"tz": "value"
}
],
"total": 59
}