Overview
You can directly link to a report. This is useful for creating direct access links for use within a browser or through an API.
Domain
Operator
Path
Time Selection
Auto-Login
Auto-Refresh
Hide Menus
Filters
Examples
Usage: https://domain?path&timeSelection&options&filter
Parameters
Domain
This is the first part of the URL
- For Sinefa Hosted it is: app.sinefa.com/
- For Self Hosted it may be: sinefa-app.yourdomain.com/
Operator
This operator '?' allows you to pass parameters to the Sinefa App
This operator '&' allows you to join multiple parameters
Path
The path specifies which report to access. The paths for each report is:
| Report Type | Report Path |
| Utilization | Application Utilization Report --> path=report/utilization/application Host Utilization Report --> path=report/utilization/host Source Utilization Report --> path=report/utilization/source |
| Quality | NQS Report --> path=report/quality/nqs Availability Report --> path=report/quality/availability Delay Report --> path=report/quality/delay Jitter Report --> path=report/quality/jitter Loss Report --> path=report/quality/loss |
Time Selection
This allows you to specify a date range. If no time selection is specified then the default date range is last 3 hours (3h).
| Date Range | URL parameter |
| Last 60 minutes | 60m |
| Last 3 hours | 3h |
| Last 6 hours | 6h |
| Last 12 hours | 12h |
| Last 24 hours | 24h |
| Last 3 days | 3d |
| Last 7 days | 7d |
| Last 14 days | 14d |
| Last 30 days | 30d |
| Yesterday | prevDay |
| Last Week | prevWeek |
| Last Month | prevMonth |
Options
Auto-login
To login automatically using credentials in the URL use the following:
https://app.sinefa.com/?apiKey=XXXX
e.g. https://app.sinefa.com/?apiKey=a1234cc-7e02-76e5-96e5-0661ffabc123
Each user has their own API Key which can be found under Settings -> Profile.
Auto-refresh
You can setup the Sinefa App to auto-refresh on any page. Specify refresh=XX where XX is the number of seconds to refresh after.
e.g. https://app.sinefa.com/?refresh=30
Hide menus
You may hide the Sinefa App menus. This is especially useful when using the Sinefa App within an iframe.
Use ui=hideMenu to hide the left hand menu.
Use ui=hideControls to hide the report filter and time selection controls.
Use ui=hideMenuControls to hide both the left hand menu and report controls.
Use ui=hideAll to hide the header, the left hand menu and the report controls.
e.g. https://app.sinefa.com/?ui=hideAll
Filter
The filters are optional parameters that allows you to further drill down into the data. The filters available differ per report type:
| Report Type | Supported Filters |
| Utilization | Probe, Application, Host, Source |
| Quality | Probe |
Probe Filter
Filter on Sinefa Probes or Sinefa Tags (groups of probes). If no Probe Filter is specified then the default is all Probes.
Application Filter
Filter on Application name. If no Application Filter is specified then the default is all Applications.
Host Filter
Filter on Host (IP Address). If no Host Filter is specified then the default is all Hosts.
Source Filter
Filter on Source (e.g. branch office). If no Source Filter is specified then the default is all Sources.
Examples
1) Link directly to Application Report
https://app.sinefa.com/?path=report/utilization/application
2) Link directly to Application report with no menus and auto-refresh every minute
https://app.sinefa.com/?path=report/utilization/application&ui=hideAll&refresh=60
3) Link directly to Network Quality report for Availability and filter to 'APAC' tag
https://app.sinefa.com/?path=report/quality/availability&timeSelection=30d&filter=probes=APAC
4) Link directly to Application Report for http and 'APAC' tag
https://app.sinefa.com/?path=report/utilization/application&filter=probe is "APAC" and application = "http"
See Also
How to Filter Sinefa Reports
How to Setup Report Scheduling
How to create a custom dashboard
API Overview
API Documentation
Comments
0 comments
Article is closed for comments.