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": 4788,
"created_at": "2024-01-17 02:08:00",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2024-01-17 02:09:24",
"format": 0,
"frequency": "value",
"last_run_at": "2024-01-17 02:05:48",
"name": "value",
"next_run_at": "2024-01-17 02:08:11",
"report_id": 9117,
"start_at": "2024-01-17 02:00:21",
"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": 448,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-09-11",
"end_at": "2024-09-11",
"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": 6663,
"created_at": "2022-04-28 06:49:06",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2022-04-28 06:52:42",
"format": 0,
"frequency": "value",
"last_run_at": "2022-04-28 06:44:14",
"name": "value",
"next_run_at": "2022-04-28 06:48:43",
"report_id": 4424,
"start_at": "2022-04-28 06:38:41",
"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/34 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": 279,
"created_at": "2018-10-24 16:37:30",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2018-10-24 16:27:47",
"format": 0,
"frequency": "value",
"last_run_at": "2018-10-24 16:24:06",
"name": "value",
"next_run_at": "2018-10-24 16:24:48",
"report_id": 7947,
"start_at": "2018-10-24 16:26: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/16 HTTP/1.1
Host: l7api.com
{
"report_id": 796,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-09-11",
"end_at": "2024-09-11",
"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": 5868,
"created_at": "2017-09-19 11:27:26",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2017-09-19 11:33:43",
"format": 0,
"frequency": "value",
"last_run_at": "2017-09-19 11:32:55",
"name": "value",
"next_run_at": "2017-09-19 11:38:49",
"report_id": 7086,
"start_at": "2017-09-19 11:33:33",
"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/19 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": 1333,
"created_at": "2018-03-14 05:49:44",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2018-03-14 05:46:53",
"format": 0,
"frequency": "value",
"last_run_at": "2018-03-14 05:49:56",
"name": "value",
"next_run_at": "2018-03-14 05:56:22",
"report_id": 1949,
"start_at": "2018-03-14 05:48:06",
"status": 1,
"timezone": "value"
}
],
"total": 59
}