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": 5406,
"created_at": "2020-12-17 09:43:44",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2020-12-17 09:34:07",
"format": 0,
"frequency": "value",
"last_run_at": "2020-12-17 09:39:42",
"name": "value",
"next_run_at": "2020-12-17 09:37:36",
"report_id": 2543,
"start_at": "2020-12-17 09:37:00",
"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": 706,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-02-10",
"end_at": "2025-02-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": 1669,
"created_at": "2018-06-01 07:49:53",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2018-06-01 07:45:17",
"format": 1,
"frequency": "value",
"last_run_at": "2018-06-01 07:57:39",
"name": "value",
"next_run_at": "2018-06-01 07:57:52",
"report_id": 4982,
"start_at": "2018-06-01 07:44:51",
"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/43 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": 239,
"created_at": "2021-04-04 21:56:07",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2021-04-04 21:55:58",
"format": 1,
"frequency": "value",
"last_run_at": "2021-04-04 21:44:25",
"name": "value",
"next_run_at": "2021-04-04 21:54:31",
"report_id": 592,
"start_at": "2021-04-04 21:47:02",
"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/6 HTTP/1.1
Host: l7api.com
{
"report_id": 105,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-02-10",
"end_at": "2025-02-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": 3237,
"created_at": "2020-10-06 19:56:05",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2020-10-06 19:49:24",
"format": 1,
"frequency": "value",
"last_run_at": "2020-10-06 20:00:06",
"name": "value",
"next_run_at": "2020-10-06 19:43:34",
"report_id": 4838,
"start_at": "2020-10-06 19:57:38",
"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/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": 4306,
"created_at": "2017-03-04 09:30:11",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2017-03-04 09:43:10",
"format": 0,
"frequency": "value",
"last_run_at": "2017-03-04 09:28:32",
"name": "value",
"next_run_at": "2017-03-04 09:32:21",
"report_id": 9550,
"start_at": "2017-03-04 09:42:15",
"status": 0,
"timezone": "value"
}
],
"total": 59
}