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": 2974,
"created_at": "2023-08-14 08:20:38",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2023-08-14 08:25:45",
"format": 0,
"frequency": "value",
"last_run_at": "2023-08-14 08:14:16",
"name": "value",
"next_run_at": "2023-08-14 08:26:48",
"report_id": 2677,
"start_at": "2023-08-14 08:20:41",
"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": 780,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2023-11-02",
"end_at": "2023-11-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": 3382,
"created_at": "2017-03-22 10:19:45",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2017-03-22 10:08:56",
"format": 0,
"frequency": "value",
"last_run_at": "2017-03-22 10:02:17",
"name": "value",
"next_run_at": "2017-03-22 10:18:42",
"report_id": 4272,
"start_at": "2017-03-22 10:14:52",
"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/33 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": 2406,
"created_at": "2017-03-18 11:49:55",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2017-03-18 12:03:03",
"format": 0,
"frequency": "value",
"last_run_at": "2017-03-18 12:05:03",
"name": "value",
"next_run_at": "2017-03-18 12:04:34",
"report_id": 9287,
"start_at": "2017-03-18 11:53:07",
"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
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/67 HTTP/1.1
Host: l7api.com
{
"report_id": 219,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2023-11-02",
"end_at": "2023-11-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": 9204,
"created_at": "2017-07-08 18:48:32",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2017-07-08 18:48:08",
"format": 0,
"frequency": "value",
"last_run_at": "2017-07-08 18:55:22",
"name": "value",
"next_run_at": "2017-07-08 18:59:19",
"report_id": 3486,
"start_at": "2017-07-08 18:59:42",
"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/26 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": 6546,
"created_at": "2022-08-02 22:59:06",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2022-08-02 22:57:38",
"format": 0,
"frequency": "value",
"last_run_at": "2022-08-02 23:06:46",
"name": "value",
"next_run_at": "2022-08-02 23:07:18",
"report_id": 8809,
"start_at": "2022-08-02 23:01:02",
"status": 0,
"timezone": "value"
}
],
"total": 59
}