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": 9186,
"created_at": "2019-04-08 16:39:22",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2019-04-08 16:38:54",
"format": 1,
"frequency": "value",
"last_run_at": "2019-04-08 16:43:05",
"name": "value",
"next_run_at": "2019-04-08 16:41:50",
"report_id": 2819,
"start_at": "2019-04-08 16:34:27",
"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": 954,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2024-12-19",
"end_at": "2024-12-19",
"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": 5009,
"created_at": "2022-07-18 13:15:03",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2022-07-18 13:17:01",
"format": 0,
"frequency": "value",
"last_run_at": "2022-07-18 13:18:26",
"name": "value",
"next_run_at": "2022-07-18 13:12:13",
"report_id": 411,
"start_at": "2022-07-18 13:13:58",
"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/97 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": 616,
"created_at": "2021-03-26 05:38:29",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2021-03-26 05:42:25",
"format": 0,
"frequency": "value",
"last_run_at": "2021-03-26 05:55:14",
"name": "value",
"next_run_at": "2021-03-26 05:51:23",
"report_id": 503,
"start_at": "2021-03-26 05:44:35",
"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/94 HTTP/1.1
Host: l7api.com
{
"report_id": 573,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2024-12-19",
"end_at": "2024-12-19",
"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": 9243,
"created_at": "2022-01-27 23:48:48",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2022-01-27 23:44:09",
"format": 1,
"frequency": "value",
"last_run_at": "2022-01-27 23:55:21",
"name": "value",
"next_run_at": "2022-01-27 23:49:51",
"report_id": 8974,
"start_at": "2022-01-27 23:44:04",
"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/89 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": 9638,
"created_at": "2018-10-06 00:48:40",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2018-10-06 00:56:23",
"format": 0,
"frequency": "value",
"last_run_at": "2018-10-06 00:51:14",
"name": "value",
"next_run_at": "2018-10-06 00:42:49",
"report_id": 8429,
"start_at": "2018-10-06 00:43:58",
"status": 0,
"timezone": "value"
}
],
"total": 59
}