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": 6676,
"created_at": "2024-12-02 10:21:42",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2024-12-02 10:37:40",
"format": 0,
"frequency": "value",
"last_run_at": "2024-12-02 10:31:36",
"name": "value",
"next_run_at": "2024-12-02 10:24:58",
"report_id": 3898,
"start_at": "2024-12-02 10:37:08",
"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": 346,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-02-19",
"end_at": "2025-02-19",
"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": 1341,
"created_at": "2019-11-14 08:35:46",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2019-11-14 08:49:14",
"format": 1,
"frequency": "value",
"last_run_at": "2019-11-14 08:50:39",
"name": "value",
"next_run_at": "2019-11-14 08:45:19",
"report_id": 9230,
"start_at": "2019-11-14 08:44:44",
"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/32 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": 6522,
"created_at": "2019-03-14 21:57:05",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2019-03-14 21:44:11",
"format": 0,
"frequency": "value",
"last_run_at": "2019-03-14 21:49:28",
"name": "value",
"next_run_at": "2019-03-14 21:53:31",
"report_id": 1415,
"start_at": "2019-03-14 21:57:50",
"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/45 HTTP/1.1
Host: l7api.com
{
"report_id": 945,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-02-19",
"end_at": "2025-02-19",
"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": 5218,
"created_at": "2016-08-21 23:48:19",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2016-08-21 23:51:31",
"format": 1,
"frequency": "value",
"last_run_at": "2016-08-21 23:56:38",
"name": "value",
"next_run_at": "2016-08-21 23:54:05",
"report_id": 546,
"start_at": "2016-08-21 23:47:03",
"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/16 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": 1174,
"created_at": "2024-12-31 04:14:01",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2024-12-31 04:03:40",
"format": 0,
"frequency": "value",
"last_run_at": "2024-12-31 03:56:25",
"name": "value",
"next_run_at": "2024-12-31 04:10:11",
"report_id": 5010,
"start_at": "2024-12-31 03:57:27",
"status": 1,
"timezone": "value"
}
],
"total": 59
}