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": 243,
"created_at": "2019-05-08 23:29:08",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2019-05-08 23:20:39",
"format": 1,
"frequency": "value",
"last_run_at": "2019-05-08 23:28:26",
"name": "value",
"next_run_at": "2019-05-08 23:22:50",
"report_id": 4525,
"start_at": "2019-05-08 23:20:24",
"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": 671,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-03-10",
"end_at": "2025-03-10",
"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": 906,
"created_at": "2022-09-14 08:51:50",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2022-09-14 08:44:43",
"format": 1,
"frequency": "value",
"last_run_at": "2022-09-14 08:44:54",
"name": "value",
"next_run_at": "2022-09-14 08:57:48",
"report_id": 7960,
"start_at": "2022-09-14 08:46:58",
"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/41 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": 4453,
"created_at": "2021-04-01 01:51:13",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2021-04-01 01:44:47",
"format": 0,
"frequency": "value",
"last_run_at": "2021-04-01 01:58:30",
"name": "value",
"next_run_at": "2021-04-01 02:04:00",
"report_id": 6038,
"start_at": "2021-04-01 01:49:08",
"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/54 HTTP/1.1
Host: l7api.com
{
"report_id": 332,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-03-10",
"end_at": "2025-03-10",
"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": 3971,
"created_at": "2016-11-22 16:19:23",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2016-11-22 16:15:48",
"format": 0,
"frequency": "value",
"last_run_at": "2016-11-22 16:14:48",
"name": "value",
"next_run_at": "2016-11-22 16:18:14",
"report_id": 8857,
"start_at": "2016-11-22 16:25:00",
"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/61 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": 772,
"created_at": "2019-04-26 05:10:03",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2019-04-26 04:59:44",
"format": 1,
"frequency": "value",
"last_run_at": "2019-04-26 05:01:54",
"name": "value",
"next_run_at": "2019-04-26 05:09:52",
"report_id": 1787,
"start_at": "2019-04-26 05:01:48",
"status": 0,
"timezone": "value"
}
],
"total": 59
}