Reports module
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": 5209,
"created_at": "2019-10-06 18:48:28",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2019-10-06 18:49:16",
"format": 0,
"frequency": "value",
"last_run_at": "2019-10-06 18:46:02",
"name": "value",
"next_run_at": "2019-10-06 18:44:17",
"report_id": 8158,
"start_at": "2019-10-06 18:47:09",
"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
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": 489,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-08-06",
"end_at": "2024-08-06",
"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": 8670,
"created_at": "2016-08-13 18:46:07",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2016-08-13 18:49:34",
"format": 0,
"frequency": "value",
"last_run_at": "2016-08-13 18:41:14",
"name": "value",
"next_run_at": "2016-08-13 18:55:11",
"report_id": 9775,
"start_at": "2016-08-13 18:52:30",
"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/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": 1351,
"created_at": "2016-08-18 03:13:23",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2016-08-18 03:08:03",
"format": 0,
"frequency": "value",
"last_run_at": "2016-08-18 03:03:36",
"name": "value",
"next_run_at": "2016-08-18 03:11:10",
"report_id": 6778,
"start_at": "2016-08-18 03:00:40",
"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
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/70 HTTP/1.1
Host: l7api.com
{
"report_id": 769,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-08-06",
"end_at": "2024-08-06",
"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": 7014,
"created_at": "2017-06-18 05:21:36",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2017-06-18 05:22:06",
"format": 0,
"frequency": "value",
"last_run_at": "2017-06-18 05:10:37",
"name": "value",
"next_run_at": "2017-06-18 05:20:29",
"report_id": 1227,
"start_at": "2017-06-18 05:15:18",
"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/24 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": 5388,
"created_at": "2022-12-06 12:49:02",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2022-12-06 13:04:00",
"format": 0,
"frequency": "value",
"last_run_at": "2022-12-06 12:51:24",
"name": "value",
"next_run_at": "2022-12-06 12:49:14",
"report_id": 998,
"start_at": "2022-12-06 12:48:29",
"status": 1,
"timezone": "value"
}
],
"total": 59
}