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": 1520,
"created_at": "2020-05-17 04:55:33",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2020-05-17 05:02:07",
"format": 0,
"frequency": "value",
"last_run_at": "2020-05-17 05:05:50",
"name": "value",
"next_run_at": "2020-05-17 05:00:26",
"report_id": 6904,
"start_at": "2020-05-17 05:14:23",
"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": 785,
"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": 4152,
"created_at": "2022-10-27 19:58:49",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2022-10-27 19:48:38",
"format": 0,
"frequency": "value",
"last_run_at": "2022-10-27 19:42:09",
"name": "value",
"next_run_at": "2022-10-27 19:42:15",
"report_id": 7056,
"start_at": "2022-10-27 19:52:05",
"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/32 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": 3486,
"created_at": "2017-09-15 14:50:02",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2017-09-15 14:42:12",
"format": 1,
"frequency": "value",
"last_run_at": "2017-09-15 14:40:33",
"name": "value",
"next_run_at": "2017-09-15 14:36:03",
"report_id": 3541,
"start_at": "2017-09-15 14:40:37",
"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/4 HTTP/1.1
Host: l7api.com
{
"report_id": 574,
"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": 4094,
"created_at": "2018-04-23 21:23:47",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2018-04-23 21:23:48",
"format": 0,
"frequency": "value",
"last_run_at": "2018-04-23 21:22:45",
"name": "value",
"next_run_at": "2018-04-23 21:24:45",
"report_id": 4331,
"start_at": "2018-04-23 21:31:22",
"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/7 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": 3740,
"created_at": "2019-10-18 23:41:35",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2019-10-18 23:47:00",
"format": 1,
"frequency": "value",
"last_run_at": "2019-10-18 23:47:07",
"name": "value",
"next_run_at": "2019-10-18 23:47:51",
"report_id": 4903,
"start_at": "2019-10-18 23:43:37",
"status": 0,
"timezone": "value"
}
],
"total": 59
}