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": 3547,
"created_at": "2022-06-19 05:10:33",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2022-06-19 05:18:53",
"format": 0,
"frequency": "value",
"last_run_at": "2022-06-19 05:10:52",
"name": "value",
"next_run_at": "2022-06-19 05:21:42",
"report_id": 2023,
"start_at": "2022-06-19 05:06:35",
"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": 198,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-08",
"end_at": "2025-01-08",
"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": 1026,
"created_at": "2016-07-27 03:44:28",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2016-07-27 03:56:02",
"format": 0,
"frequency": "value",
"last_run_at": "2016-07-27 03:48:00",
"name": "value",
"next_run_at": "2016-07-27 03:41:23",
"report_id": 8966,
"start_at": "2016-07-27 03:57:04",
"status": 1,
"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/81 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": 515,
"created_at": "2020-09-16 05:31:09",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2020-09-16 05:27:12",
"format": 0,
"frequency": "value",
"last_run_at": "2020-09-16 05:28:07",
"name": "value",
"next_run_at": "2020-09-16 05:30:13",
"report_id": 226,
"start_at": "2020-09-16 05:30:03",
"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/74 HTTP/1.1
Host: l7api.com
{
"report_id": 103,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-08",
"end_at": "2025-01-08",
"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": 3076,
"created_at": "2018-10-07 11:44:39",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2018-10-07 11:35:54",
"format": 0,
"frequency": "value",
"last_run_at": "2018-10-07 11:44:21",
"name": "value",
"next_run_at": "2018-10-07 11:48:33",
"report_id": 3371,
"start_at": "2018-10-07 11:45:11",
"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/95 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": 1819,
"created_at": "2021-05-16 05:52:49",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2021-05-16 05:46:54",
"format": 0,
"frequency": "value",
"last_run_at": "2021-05-16 05:46:26",
"name": "value",
"next_run_at": "2021-05-16 06:03:46",
"report_id": 1237,
"start_at": "2021-05-16 06:03:53",
"status": 1,
"timezone": "value"
}
],
"total": 59
}