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": 938,
"created_at": "2018-01-21 02:46:02",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2018-01-21 02:42:22",
"format": 0,
"frequency": "value",
"last_run_at": "2018-01-21 02:41:18",
"name": "value",
"next_run_at": "2018-01-21 02:52:05",
"report_id": 4111,
"start_at": "2018-01-21 02:50:15",
"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": 302,
"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": 7165,
"created_at": "2016-08-22 08:04:13",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2016-08-22 08:19:57",
"format": 0,
"frequency": "value",
"last_run_at": "2016-08-22 08:22:29",
"name": "value",
"next_run_at": "2016-08-22 08:03:47",
"report_id": 2021,
"start_at": "2016-08-22 08:16:44",
"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/47 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": 8348,
"created_at": "2023-02-05 13:09:23",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2023-02-05 13:13:02",
"format": 1,
"frequency": "value",
"last_run_at": "2023-02-05 13:12:28",
"name": "value",
"next_run_at": "2023-02-05 13:15:38",
"report_id": 4659,
"start_at": "2023-02-05 13:17:31",
"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/42 HTTP/1.1
Host: l7api.com
{
"report_id": 232,
"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": 1192,
"created_at": "2023-10-28 00:17:24",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2023-10-28 00:12:29",
"format": 1,
"frequency": "value",
"last_run_at": "2023-10-28 00:11:08",
"name": "value",
"next_run_at": "2023-10-28 00:09:08",
"report_id": 1079,
"start_at": "2023-10-28 00:00:20",
"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/15 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": 1660,
"created_at": "2020-11-27 04:44:42",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2020-11-27 04:52:55",
"format": 0,
"frequency": "value",
"last_run_at": "2020-11-27 04:51:20",
"name": "value",
"next_run_at": "2020-11-27 04:48:42",
"report_id": 4863,
"start_at": "2020-11-27 04:47:20",
"status": 1,
"timezone": "value"
}
],
"total": 59
}