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": 6781,
"created_at": "2019-11-05 11:54:20",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2019-11-05 11:46:09",
"format": 0,
"frequency": "value",
"last_run_at": "2019-11-05 11:40:17",
"name": "value",
"next_run_at": "2019-11-05 11:41:15",
"report_id": 7201,
"start_at": "2019-11-05 11:53:03",
"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": 123,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 2351,
"created_at": "2023-05-11 20:58:55",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2023-05-11 21:08:21",
"format": 0,
"frequency": "value",
"last_run_at": "2023-05-11 21:09:40",
"name": "value",
"next_run_at": "2023-05-11 21:04:22",
"report_id": 5869,
"start_at": "2023-05-11 20:58:57",
"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/68 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": 4251,
"created_at": "2021-05-21 02:18:26",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2021-05-21 02:06:21",
"format": 0,
"frequency": "value",
"last_run_at": "2021-05-21 02:13:04",
"name": "value",
"next_run_at": "2021-05-21 02:21:43",
"report_id": 1369,
"start_at": "2021-05-21 02:09:26",
"status": 0,
"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/85 HTTP/1.1
Host: l7api.com
{
"report_id": 880,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 4064,
"created_at": "2017-10-03 13:13:54",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2017-10-03 13:19:03",
"format": 1,
"frequency": "value",
"last_run_at": "2017-10-03 13:22:24",
"name": "value",
"next_run_at": "2017-10-03 13:08:21",
"report_id": 6753,
"start_at": "2017-10-03 13:17:08",
"status": 1,
"timezone": "value"
},
"links": {}
}
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/73 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": 5805,
"created_at": "2018-08-23 22:53:11",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2018-08-23 23:06:23",
"format": 1,
"frequency": "value",
"last_run_at": "2018-08-23 22:54:51",
"name": "value",
"next_run_at": "2018-08-23 22:55:33",
"report_id": 2070,
"start_at": "2018-08-23 22:58:32",
"status": 0,
"timezone": "value"
}
],
"total": 59
}