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": 498,
"created_at": "2019-02-08 12:12:38",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2019-02-08 12:13:29",
"format": 1,
"frequency": "value",
"last_run_at": "2019-02-08 12:11:17",
"name": "value",
"next_run_at": "2019-02-08 12:12:22",
"report_id": 7451,
"start_at": "2019-02-08 12:15:31",
"status": 0,
"timezone": "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
timezone string
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1
Host: l7api.com
{
"report_id": 527,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-03-10",
"end_at": "2025-03-10",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"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": 5725,
"created_at": "2021-01-11 03:08:05",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2021-01-11 03:07:52",
"format": 1,
"frequency": "value",
"last_run_at": "2021-01-11 03:20:46",
"name": "value",
"next_run_at": "2021-01-11 03:10:29",
"report_id": 1416,
"start_at": "2021-01-11 03:16:37",
"status": 1,
"timezone": "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/85 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": 3550,
"created_at": "2024-11-14 14:05:58",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2024-11-14 14:24:35",
"format": 0,
"frequency": "value",
"last_run_at": "2024-11-14 14:24:44",
"name": "value",
"next_run_at": "2024-11-14 14:16:46",
"report_id": 8408,
"start_at": "2024-11-14 14:07:49",
"status": 1,
"timezone": "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
timezone string
Example Request
PATCH /v1.1/voipstudio/reportschedules/46 HTTP/1.1
Host: l7api.com
{
"report_id": 500,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-03-10",
"end_at": "2025-03-10",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"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": 8871,
"created_at": "2024-03-18 15:48:35",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2024-03-18 16:00:01",
"format": 1,
"frequency": "value",
"last_run_at": "2024-03-18 15:48:08",
"name": "value",
"next_run_at": "2024-03-18 15:54:55",
"report_id": 797,
"start_at": "2024-03-18 15:47:56",
"status": 0,
"timezone": "value"
},
"links": {}
}
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/64 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": 7054,
"created_at": "2017-07-17 20:31:48",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2017-07-17 20:20:03",
"format": 0,
"frequency": "value",
"last_run_at": "2017-07-17 20:29:04",
"name": "value",
"next_run_at": "2017-07-17 20:33:56",
"report_id": 9052,
"start_at": "2017-07-17 20:21:58",
"status": 0,
"timezone": "value"
}
],
"total": 59
}