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": 5618,
"created_at": "2017-12-09 09:17:46",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2017-12-09 09:07:58",
"format": 0,
"frequency": "value",
"last_run_at": "2017-12-09 09:12:51",
"name": "value",
"next_run_at": "2017-12-09 09:18:56",
"report_id": 7959,
"start_at": "2017-12-09 09:18:14",
"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": 877,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-09",
"end_at": "2025-01-09",
"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": 9323,
"created_at": "2018-11-25 12:05:57",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2018-11-25 11:56:03",
"format": 1,
"frequency": "value",
"last_run_at": "2018-11-25 12:02:27",
"name": "value",
"next_run_at": "2018-11-25 11:59:15",
"report_id": 1252,
"start_at": "2018-11-25 11:51:08",
"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/78 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": 9691,
"created_at": "2016-11-01 17:20:41",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2016-11-01 17:09:27",
"format": 0,
"frequency": "value",
"last_run_at": "2016-11-01 17:23:12",
"name": "value",
"next_run_at": "2016-11-01 17:23:48",
"report_id": 8585,
"start_at": "2016-11-01 17:25: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
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/95 HTTP/1.1
Host: l7api.com
{
"report_id": 296,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-09",
"end_at": "2025-01-09",
"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": 20,
"created_at": "2020-03-31 22:17:12",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2020-03-31 22:24:14",
"format": 1,
"frequency": "value",
"last_run_at": "2020-03-31 22:26:38",
"name": "value",
"next_run_at": "2020-03-31 22:23:13",
"report_id": 4138,
"start_at": "2020-03-31 22:23:27",
"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/78 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": 6410,
"created_at": "2019-03-12 08:25:10",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2019-03-12 08:33:19",
"format": 1,
"frequency": "value",
"last_run_at": "2019-03-12 08:19:18",
"name": "value",
"next_run_at": "2019-03-12 08:28:28",
"report_id": 2633,
"start_at": "2019-03-12 08:31:44",
"status": 0,
"timezone": "value"
}
],
"total": 59
}