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": 6406,
"created_at": "2022-09-22 23:13:57",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2022-09-22 23:22:27",
"format": 1,
"frequency": "value",
"last_run_at": "2022-09-22 23:14:47",
"name": "value",
"next_run_at": "2022-09-22 23:19:29",
"report_id": 7480,
"start_at": "2022-09-22 23:04:32",
"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": 362,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-09",
"end_at": "2025-01-09",
"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": 9804,
"created_at": "2023-01-02 00:44:36",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2023-01-02 00:47:22",
"format": 1,
"frequency": "value",
"last_run_at": "2023-01-02 00:46:58",
"name": "value",
"next_run_at": "2023-01-02 00:42:01",
"report_id": 3536,
"start_at": "2023-01-02 00:43:56",
"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/68 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": 623,
"created_at": "2021-02-03 05:25:55",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2021-02-03 05:39:20",
"format": 1,
"frequency": "value",
"last_run_at": "2021-02-03 05:36:49",
"name": "value",
"next_run_at": "2021-02-03 05:34:44",
"report_id": 9364,
"start_at": "2021-02-03 05:40:10",
"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/67 HTTP/1.1
Host: l7api.com
{
"report_id": 889,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-09",
"end_at": "2025-01-09",
"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": 438,
"created_at": "2024-07-11 14:56:33",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2024-07-11 14:55:34",
"format": 0,
"frequency": "value",
"last_run_at": "2024-07-11 14:51:37",
"name": "value",
"next_run_at": "2024-07-11 14:46:30",
"report_id": 981,
"start_at": "2024-07-11 14:50:45",
"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/8 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": 7806,
"created_at": "2022-04-06 13:58:57",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2022-04-06 14:13:13",
"format": 1,
"frequency": "value",
"last_run_at": "2022-04-06 14:08:29",
"name": "value",
"next_run_at": "2022-04-06 13:59:22",
"report_id": 7370,
"start_at": "2022-04-06 13:58:41",
"status": 1,
"timezone": "value"
}
],
"total": 59
}