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": 6173,
"created_at": "2024-12-15 20:43:15",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2024-12-15 20:38:52",
"format": 0,
"frequency": "value",
"last_run_at": "2024-12-15 20:28:43",
"name": "value",
"next_run_at": "2024-12-15 20:36:58",
"report_id": 2213,
"start_at": "2024-12-15 20:42:16",
"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
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": 294,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-04-14",
"end_at": "2025-04-14",
"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": 3680,
"created_at": "2023-08-13 06:41:56",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2023-08-13 06:48:38",
"format": 0,
"frequency": "value",
"last_run_at": "2023-08-13 06:44:32",
"name": "value",
"next_run_at": "2023-08-13 06:42:18",
"report_id": 3246,
"start_at": "2023-08-13 06:52:13",
"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/73 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": 140,
"created_at": "2019-11-13 21:13:02",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2019-11-13 21:27:44",
"format": 0,
"frequency": "value",
"last_run_at": "2019-11-13 21:26:34",
"name": "value",
"next_run_at": "2019-11-13 21:12:13",
"report_id": 1782,
"start_at": "2019-11-13 21:22:56",
"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
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/30 HTTP/1.1
Host: l7api.com
{
"report_id": 356,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-04-14",
"end_at": "2025-04-14",
"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": 2217,
"created_at": "2020-09-22 12:00:31",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2020-09-22 12:04:45",
"format": 1,
"frequency": "value",
"last_run_at": "2020-09-22 12:08:36",
"name": "value",
"next_run_at": "2020-09-22 12:06:44",
"report_id": 6199,
"start_at": "2020-09-22 12:13:12",
"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/6 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": 8154,
"created_at": "2021-04-11 04:30:24",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2021-04-11 04:40:18",
"format": 1,
"frequency": "value",
"last_run_at": "2021-04-11 04:35:57",
"name": "value",
"next_run_at": "2021-04-11 04:42:38",
"report_id": 6106,
"start_at": "2021-04-11 04:28:36",
"status": 0,
"timezone": "value"
}
],
"total": 59
}