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": 9022,
"created_at": "2023-12-01 09:13:09",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2023-12-01 09:09:46",
"format": 0,
"frequency": "value",
"last_run_at": "2023-12-01 08:57:53",
"name": "value",
"next_run_at": "2023-12-01 09:06:11",
"report_id": 9415,
"start_at": "2023-12-01 09:07:57",
"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": 814,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-08-06",
"end_at": "2024-08-06",
"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": 2731,
"created_at": "2022-02-03 08:20:47",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2022-02-03 08:17:56",
"format": 0,
"frequency": "value",
"last_run_at": "2022-02-03 08:25:44",
"name": "value",
"next_run_at": "2022-02-03 08:22:16",
"report_id": 8841,
"start_at": "2022-02-03 08:18:32",
"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/72 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": 1178,
"created_at": "2021-08-15 22:17:05",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2021-08-15 22:22:52",
"format": 0,
"frequency": "value",
"last_run_at": "2021-08-15 22:23:21",
"name": "value",
"next_run_at": "2021-08-15 22:23:32",
"report_id": 8621,
"start_at": "2021-08-15 22:10:37",
"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/28 HTTP/1.1
Host: l7api.com
{
"report_id": 106,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-08-06",
"end_at": "2024-08-06",
"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": 6708,
"created_at": "2017-09-22 15:15:37",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2017-09-22 15:04:04",
"format": 0,
"frequency": "value",
"last_run_at": "2017-09-22 15:10:35",
"name": "value",
"next_run_at": "2017-09-22 15:06:04",
"report_id": 9914,
"start_at": "2017-09-22 15:13:46",
"status": 1,
"timezone": "value"
},
"links": {}
}
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/23 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": 8078,
"created_at": "2024-01-24 01:38:34",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2024-01-24 01:46:25",
"format": 0,
"frequency": "value",
"last_run_at": "2024-01-24 01:37:26",
"name": "value",
"next_run_at": "2024-01-24 01:34:12",
"report_id": 8272,
"start_at": "2024-01-24 01:40:16",
"status": 1,
"timezone": "value"
}
],
"total": 59
}