Reports module
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": 9811,
"created_at": "2019-08-16 07:43:20",
"culture": 5,
"description": "value",
"emails": "value",
"end_at": "2019-08-16 07:40:11",
"format": 0,
"frequency": "value",
"last_run_at": "2019-08-16 07:32:03",
"name": "value",
"next_run_at": "2019-08-16 07:39:17",
"report_id": 9245,
"start_at": "2019-08-16 07:44:17",
"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
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": 192,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-11-14",
"end_at": "2024-11-14",
"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": 1414,
"created_at": "2024-01-12 16:19:54",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2024-01-12 16:22:10",
"format": 0,
"frequency": "value",
"last_run_at": "2024-01-12 16:31:27",
"name": "value",
"next_run_at": "2024-01-12 16:29:58",
"report_id": 5122,
"start_at": "2024-01-12 16:37:01",
"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/12 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": 4378,
"created_at": "2018-01-15 07:43:54",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2018-01-15 07:48:41",
"format": 0,
"frequency": "value",
"last_run_at": "2018-01-15 07:37:45",
"name": "value",
"next_run_at": "2018-01-15 07:43:46",
"report_id": 2224,
"start_at": "2018-01-15 07:51:11",
"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
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/39 HTTP/1.1
Host: l7api.com
{
"report_id": 335,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-11-14",
"end_at": "2024-11-14",
"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": 9938,
"created_at": "2020-11-15 09:54:38",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2020-11-15 10:03:00",
"format": 0,
"frequency": "value",
"last_run_at": "2020-11-15 10:00:40",
"name": "value",
"next_run_at": "2020-11-15 10:08:29",
"report_id": 3757,
"start_at": "2020-11-15 09:50:53",
"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/52 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": 5570,
"created_at": "2024-07-13 06:40:48",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2024-07-13 06:40:13",
"format": 0,
"frequency": "value",
"last_run_at": "2024-07-13 06:42:52",
"name": "value",
"next_run_at": "2024-07-13 06:51:01",
"report_id": 4348,
"start_at": "2024-07-13 06:49:21",
"status": 1,
"timezone": "value"
}
],
"total": 59
}