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": 5499,
"created_at": "2018-09-13 03:52:18",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2018-09-13 03:45:29",
"format": 0,
"frequency": "value",
"last_run_at": "2018-09-13 03:52:51",
"name": "value",
"next_run_at": "2018-09-13 03:41:19",
"report_id": 9133,
"start_at": "2018-09-13 03:48:46",
"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
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": 236,
"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": 4227,
"created_at": "2017-11-01 05:16:43",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2017-11-01 05:09:41",
"format": 1,
"frequency": "value",
"last_run_at": "2017-11-01 05:21:40",
"name": "value",
"next_run_at": "2017-11-01 05:20:39",
"report_id": 7793,
"start_at": "2017-11-01 05:07:19",
"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/53 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": 1704,
"created_at": "2017-02-09 14:07:23",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2017-02-09 14:07:24",
"format": 0,
"frequency": "value",
"last_run_at": "2017-02-09 14:24:59",
"name": "value",
"next_run_at": "2017-02-09 14:10:06",
"report_id": 2542,
"start_at": "2017-02-09 14:10:35",
"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
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/29 HTTP/1.1
Host: l7api.com
{
"report_id": 972,
"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": 5582,
"created_at": "2023-07-30 23:40:57",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2023-07-30 23:37:36",
"format": 1,
"frequency": "value",
"last_run_at": "2023-07-30 23:36:50",
"name": "value",
"next_run_at": "2023-07-30 23:29:59",
"report_id": 6166,
"start_at": "2023-07-30 23:45:02",
"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/97 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": 9554,
"created_at": "2024-02-04 06:14:21",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2024-02-04 06:16:45",
"format": 1,
"frequency": "value",
"last_run_at": "2024-02-04 06:20:15",
"name": "value",
"next_run_at": "2024-02-04 06:18:45",
"report_id": 255,
"start_at": "2024-02-04 06:09:03",
"status": 1,
"timezone": "value"
}
],
"total": 59
}