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": 9108,
"created_at": "2017-04-14 21:38:42",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2017-04-14 21:26:59",
"format": 1,
"frequency": "value",
"last_run_at": "2017-04-14 21:30:16",
"name": "value",
"next_run_at": "2017-04-14 21:40:37",
"report_id": 4106,
"start_at": "2017-04-14 21:33:58",
"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": 728,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-21",
"end_at": "2025-01-21",
"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": 4045,
"created_at": "2024-10-12 03:29:57",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2024-10-12 03:35:56",
"format": 1,
"frequency": "value",
"last_run_at": "2024-10-12 03:36:44",
"name": "value",
"next_run_at": "2024-10-12 03:18:36",
"report_id": 99,
"start_at": "2024-10-12 03:25:59",
"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/80 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": 4058,
"created_at": "2018-04-01 00:42:28",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2018-04-01 00:44:11",
"format": 0,
"frequency": "value",
"last_run_at": "2018-04-01 00:50:58",
"name": "value",
"next_run_at": "2018-04-01 00:49:48",
"report_id": 2149,
"start_at": "2018-04-01 00:54:22",
"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/99 HTTP/1.1
Host: l7api.com
{
"report_id": 884,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-21",
"end_at": "2025-01-21",
"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": 9809,
"created_at": "2021-07-16 01:33:21",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2021-07-16 01:34:58",
"format": 0,
"frequency": "value",
"last_run_at": "2021-07-16 01:33:27",
"name": "value",
"next_run_at": "2021-07-16 01:33:57",
"report_id": 9918,
"start_at": "2021-07-16 01:24:47",
"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/44 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": 8586,
"created_at": "2020-08-26 04:05:01",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2020-08-26 04:11:37",
"format": 1,
"frequency": "value",
"last_run_at": "2020-08-26 04:08:44",
"name": "value",
"next_run_at": "2020-08-26 04:12:25",
"report_id": 7335,
"start_at": "2020-08-26 03:55:49",
"status": 0,
"timezone": "value"
}
],
"total": 59
}