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": 5147,
"created_at": "2018-02-06 19:18:11",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2018-02-06 19:00:14",
"format": 1,
"frequency": "value",
"last_run_at": "2018-02-06 19:01:09",
"name": "value",
"next_run_at": "2018-02-06 19:12:26",
"report_id": 707,
"start_at": "2018-02-06 19:05:38",
"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": 507,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 8031,
"created_at": "2018-10-12 02:49:56",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2018-10-12 02:58:43",
"format": 1,
"frequency": "value",
"last_run_at": "2018-10-12 03:04:13",
"name": "value",
"next_run_at": "2018-10-12 02:49:11",
"report_id": 6569,
"start_at": "2018-10-12 03:00:17",
"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/58 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": 2874,
"created_at": "2024-03-30 11:59:51",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2024-03-30 11:53:34",
"format": 1,
"frequency": "value",
"last_run_at": "2024-03-30 11:49:38",
"name": "value",
"next_run_at": "2024-03-30 11:47:45",
"report_id": 1102,
"start_at": "2024-03-30 11:45:31",
"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/88 HTTP/1.1
Host: l7api.com
{
"report_id": 351,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 8223,
"created_at": "2023-01-17 04:26:17",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2023-01-17 04:35:47",
"format": 0,
"frequency": "value",
"last_run_at": "2023-01-17 04:25:48",
"name": "value",
"next_run_at": "2023-01-17 04:30:48",
"report_id": 9099,
"start_at": "2023-01-17 04:25:28",
"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/87 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": 1996,
"created_at": "2018-09-07 18:45:23",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2018-09-07 18:44:30",
"format": 0,
"frequency": "value",
"last_run_at": "2018-09-07 18:46:29",
"name": "value",
"next_run_at": "2018-09-07 18:53:54",
"report_id": 3544,
"start_at": "2018-09-07 18:49:26",
"status": 1,
"timezone": "value"
}
],
"total": 59
}