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": 8820,
"created_at": "2023-08-12 17:57:32",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2023-08-12 18:11:26",
"format": 0,
"frequency": "value",
"last_run_at": "2023-08-12 18:00:00",
"name": "value",
"next_run_at": "2023-08-12 18:05:18",
"report_id": 7795,
"start_at": "2023-08-12 18:13:27",
"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": 257,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-12-03",
"end_at": "2024-12-03",
"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": 4216,
"created_at": "2023-10-10 16:35:31",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2023-10-10 16:36:35",
"format": 1,
"frequency": "value",
"last_run_at": "2023-10-10 16:51:20",
"name": "value",
"next_run_at": "2023-10-10 16:40:15",
"report_id": 9949,
"start_at": "2023-10-10 16:41: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/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": 5014,
"created_at": "2019-10-24 08:16:31",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2019-10-24 08:21:02",
"format": 1,
"frequency": "value",
"last_run_at": "2019-10-24 08:07:19",
"name": "value",
"next_run_at": "2019-10-24 08:19:55",
"report_id": 7162,
"start_at": "2019-10-24 08:13:59",
"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/95 HTTP/1.1
Host: l7api.com
{
"report_id": 477,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-12-03",
"end_at": "2024-12-03",
"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": 307,
"created_at": "2018-11-02 21:00:22",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2018-11-02 20:49:55",
"format": 1,
"frequency": "value",
"last_run_at": "2018-11-02 20:57:42",
"name": "value",
"next_run_at": "2018-11-02 21:05:23",
"report_id": 6547,
"start_at": "2018-11-02 21:01:31",
"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/79 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": 7544,
"created_at": "2021-01-19 23:14:57",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2021-01-19 23:28:20",
"format": 1,
"frequency": "value",
"last_run_at": "2021-01-19 23:28:31",
"name": "value",
"next_run_at": "2021-01-19 23:29:55",
"report_id": 2455,
"start_at": "2021-01-19 23:18:07",
"status": 0,
"timezone": "value"
}
],
"total": 59
}