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": 6699,
"created_at": "2023-09-10 22:50:42",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2023-09-10 22:43:26",
"format": 0,
"frequency": "value",
"last_run_at": "2023-09-10 22:47:23",
"name": "value",
"next_run_at": "2023-09-10 22:40:17",
"report_id": 5113,
"start_at": "2023-09-10 22:50:54",
"status": 1,
"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": 303,
"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": 160,
"created_at": "2017-10-28 18:13:11",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2017-10-28 18:17:34",
"format": 1,
"frequency": "value",
"last_run_at": "2017-10-28 18:11:31",
"name": "value",
"next_run_at": "2017-10-28 18:22:40",
"report_id": 3172,
"start_at": "2017-10-28 18:14:34",
"status": 0,
"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": 918,
"created_at": "2020-11-29 12:26:47",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2020-11-29 12:29:13",
"format": 1,
"frequency": "value",
"last_run_at": "2020-11-29 12:25:40",
"name": "value",
"next_run_at": "2020-11-29 12:32:21",
"report_id": 4391,
"start_at": "2020-11-29 12:25:45",
"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/52 HTTP/1.1
Host: l7api.com
{
"report_id": 383,
"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": 4530,
"created_at": "2024-06-25 06:36:48",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2024-06-25 06:50:24",
"format": 0,
"frequency": "value",
"last_run_at": "2024-06-25 06:45:58",
"name": "value",
"next_run_at": "2024-06-25 06:53:58",
"report_id": 5586,
"start_at": "2024-06-25 06:47:12",
"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/46 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": 1867,
"created_at": "2024-09-28 20:38:27",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2024-09-28 20:44:33",
"format": 0,
"frequency": "value",
"last_run_at": "2024-09-28 20:34:11",
"name": "value",
"next_run_at": "2024-09-28 20:37:44",
"report_id": 7229,
"start_at": "2024-09-28 20:32:51",
"status": 1,
"timezone": "value"
}
],
"total": 59
}