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": 439,
"created_at": "2017-10-16 17:47:17",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2017-10-16 17:37:05",
"format": 0,
"frequency": "value",
"last_run_at": "2017-10-16 17:46:46",
"name": "value",
"next_run_at": "2017-10-16 17:40:47",
"report_id": 3760,
"start_at": "2017-10-16 17:43:49",
"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": 641,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-04-14",
"end_at": "2025-04-14",
"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": 5632,
"created_at": "2022-04-05 19:05:56",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2022-04-05 18:59:48",
"format": 1,
"frequency": "value",
"last_run_at": "2022-04-05 18:59:42",
"name": "value",
"next_run_at": "2022-04-05 18:56:04",
"report_id": 8925,
"start_at": "2022-04-05 19:08:47",
"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/45 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": 586,
"created_at": "2017-08-24 01:31:06",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2017-08-24 01:37:44",
"format": 0,
"frequency": "value",
"last_run_at": "2017-08-24 01:32:52",
"name": "value",
"next_run_at": "2017-08-24 01:37:21",
"report_id": 4285,
"start_at": "2017-08-24 01:49:15",
"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/66 HTTP/1.1
Host: l7api.com
{
"report_id": 212,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-04-14",
"end_at": "2025-04-14",
"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": 7434,
"created_at": "2021-11-20 07:05:18",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2021-11-20 07:01:40",
"format": 1,
"frequency": "value",
"last_run_at": "2021-11-20 06:53:12",
"name": "value",
"next_run_at": "2021-11-20 06:57:39",
"report_id": 761,
"start_at": "2021-11-20 07:02:34",
"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/63 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": 9805,
"created_at": "2019-10-10 23:45:50",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2019-10-10 23:30:06",
"format": 1,
"frequency": "value",
"last_run_at": "2019-10-10 23:42:39",
"name": "value",
"next_run_at": "2019-10-10 23:41:32",
"report_id": 9565,
"start_at": "2019-10-10 23:44:21",
"status": 1,
"timezone": "value"
}
],
"total": 59
}