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": 3297,
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2018-11-21 22:25:48",
"format": 0,
"frequency": "value",
"name": "value",
"report_id": 9211,
"start_at": "2018-11-21 22:18:06"
}
],
"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
frequency array
Array of frequency config options
Array of frequency config options
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1
Host: l7api.com
{
"report_id": 642,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2023-09-12",
"end_at": "2023-09-12",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
}
}
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": 6850,
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2017-11-22 21:27:13",
"format": 0,
"frequency": "value",
"name": "value",
"report_id": 3467,
"start_at": "2017-11-22 21:24:17"
},
"links": {}
}
GET
/reportschedules/{id} Returns Report schedule resource for given Id
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
GET /v1.1/voipstudio/reportschedules/96 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": 4338,
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2020-07-18 10:28:33",
"format": 0,
"frequency": "value",
"name": "value",
"report_id": 8624,
"start_at": "2020-07-18 10:17:57"
},
"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
frequency array
Array of frequency config options
Array of frequency config options
Example Request
PATCH /v1.1/voipstudio/reportschedules/85 HTTP/1.1
Host: l7api.com
{
"report_id": 394,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2023-09-12",
"end_at": "2023-09-12",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
}
}
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": 4960,
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2019-05-01 01:21:25",
"format": 0,
"frequency": "value",
"name": "value",
"report_id": 577,
"start_at": "2019-05-01 01:14:20"
},
"links": {}
}
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/17 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": 9599,
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2021-01-25 20:12:24",
"format": 0,
"frequency": "value",
"name": "value",
"report_id": 3360,
"start_at": "2021-01-25 20:03:17"
}
],
"total": 59
}