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": 6366,
"created_at": "2024-02-17 04:45:19",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2024-02-17 04:56:40",
"format": 0,
"frequency": "value",
"last_run_at": "2024-02-17 04:41:40",
"name": "value",
"next_run_at": "2024-02-17 04:40:50",
"report_id": 8023,
"start_at": "2024-02-17 04:46:19",
"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": 572,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-09-04",
"end_at": "2024-09-04",
"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": 5846,
"created_at": "2021-09-03 06:17:58",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2021-09-03 06:23:24",
"format": 0,
"frequency": "value",
"last_run_at": "2021-09-03 06:23:08",
"name": "value",
"next_run_at": "2021-09-03 06:15:49",
"report_id": 5226,
"start_at": "2021-09-03 06:25:26",
"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/69 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": 7994,
"created_at": "2020-02-24 22:44:20",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2020-02-24 22:36:00",
"format": 0,
"frequency": "value",
"last_run_at": "2020-02-24 22:45:29",
"name": "value",
"next_run_at": "2020-02-24 22:35:30",
"report_id": 6611,
"start_at": "2020-02-24 22:41:49",
"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/14 HTTP/1.1
Host: l7api.com
{
"report_id": 372,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-09-04",
"end_at": "2024-09-04",
"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": 3513,
"created_at": "2018-10-07 14:48:20",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2018-10-07 14:48:09",
"format": 0,
"frequency": "value",
"last_run_at": "2018-10-07 14:50:29",
"name": "value",
"next_run_at": "2018-10-07 14:51:14",
"report_id": 3898,
"start_at": "2018-10-07 14:48:00",
"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/46 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": 2062,
"created_at": "2024-03-23 16:57:31",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2024-03-23 17:04:42",
"format": 0,
"frequency": "value",
"last_run_at": "2024-03-23 17:07:48",
"name": "value",
"next_run_at": "2024-03-23 17:05:18",
"report_id": 5904,
"start_at": "2024-03-23 16:59:11",
"status": 1,
"timezone": "value"
}
],
"total": 59
}