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": 946,
"created_at": "2021-05-19 00:22:55",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2021-05-19 00:10:45",
"format": 0,
"frequency": "value",
"last_run_at": "2021-05-19 00:29:37",
"name": "value",
"next_run_at": "2021-05-19 00:19:41",
"report_id": 7983,
"start_at": "2021-05-19 00:26:07",
"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
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": 226,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-09-12",
"end_at": "2024-09-12",
"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": 3639,
"created_at": "2020-06-08 07:06:38",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2020-06-08 07:17:02",
"format": 0,
"frequency": "value",
"last_run_at": "2020-06-08 07:12:31",
"name": "value",
"next_run_at": "2020-06-08 07:05:33",
"report_id": 7685,
"start_at": "2020-06-08 07:20:35",
"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/39 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": 6973,
"created_at": "2022-09-05 12:51:10",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2022-09-05 12:45:25",
"format": 0,
"frequency": "value",
"last_run_at": "2022-09-05 12:34:20",
"name": "value",
"next_run_at": "2022-09-05 12:50:17",
"report_id": 1459,
"start_at": "2022-09-05 12:36:44",
"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/44 HTTP/1.1
Host: l7api.com
{
"report_id": 893,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-09-12",
"end_at": "2024-09-12",
"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": 513,
"created_at": "2017-05-07 18:21:56",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2017-05-07 18:19:23",
"format": 0,
"frequency": "value",
"last_run_at": "2017-05-07 18:18:53",
"name": "value",
"next_run_at": "2017-05-07 18:28:29",
"report_id": 1803,
"start_at": "2017-05-07 18:24:30",
"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/29 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": 4999,
"created_at": "2023-03-28 00:58:27",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2023-03-28 00:52:56",
"format": 0,
"frequency": "value",
"last_run_at": "2023-03-28 00:59:38",
"name": "value",
"next_run_at": "2023-03-28 00:59:37",
"report_id": 4694,
"start_at": "2023-03-28 01:11:24",
"status": 0,
"timezone": "value"
}
],
"total": 59
}