BaxEnergy

For details on usage limits (like requests per hour/month), please refer to the dedicated limitations article 

- For details on usage limits (like requests per hour/month), please refer to the dedicated limitations article 

Get A Paginated List of Reports (GET/v1/reports) 

Go to: <a href="https://api.farsight.gg/swagger/index.html#/Reports/Reports_GetReports" rel="nofollow noopener noreferrer" target="_blank">https://api.farsight.gg/swagger/index.html#/Reports/Reports_GetReports</a>

The following parameters are used to filter, sort, and paginate the list of reports returned in the response. All parameters are optional unless otherwise noted.

Get Reports for an Asset (GET/v1/reports/{id}) 

Go to: <a href="https://api.farsight.gg/swagger/index.html#/Reports/Reports_GetReport" rel="nofollow noopener noreferrer" target="_blank">https://api.farsight.gg/swagger/index.html#/Reports/Reports_GetReport</a>

Farsight® Reports API

Find answers and get help from Intercom Support and Community Experts

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

Input Parameter	Type	Required	Definition
Limit	integer	No	The number of items you want the API to return. It can range from 1 to 50 (Free) or 1 to 500 (Pro). The default value is set to 25.
Offset	integer	No	The index of the first item to return. Must be 0 or greater. It is set to 0 by default.
State	string	No	The desired state of reports you want returned.
Type	string	No	The desired type of reports you want returned. The available options are FaultsAndMaintenance, Efficiency, and ExecutivePortfolio.
CreatedBefore	string	No	The maximal creation date of the reports. Entries with a creation date less than or equal to this value will be included. It can be in UNIX seconds or a UTC Timestamp (ISO 8601).
CreatedAfter	string	No	The minimal creation date of the reports. Entries with a creation date greater than or equal to this value will be included. It can be in UNIX seconds or a UTC Timestamp (ISO 8601).
PeriodStartBefore	string	No	The maximal start date of the period of the reports. Entries with a period start date less or equal than this value will be included. It can be in UNIX seconds or a UTC Timestamp (ISO 8601).
PeriodStartAfter	string	No	The maximal start date of the period of the reports. Entries with a period start date greater than or equal to the reports. It can be in UNIX seconds or a UTC Timestamp (ISO 8601).
PeriodEndBefore	string	No	The start date to get alarms, entries with a start time greater than or equal to this value will be included. It can be in UNIX seconds or a UTC Timestamp (ISO 8601).
PeriodEndAfter	string	No	The maximal start date of the period of the reports. Entries with a period start date less than or equal to this value will be included. It can be in UNIX seconds or a UTC Timestamp (ISO 8601).
sort	string	No	Fields used in the results sorting. Composed by the name of the field followed by :asc or :desc. Example: id:asc.

Input Parameter	Type	Required	Definition
id	string	Yes	The ID of the asset you want reports returned for.

Farsight® Reports API

Requirements

Limitations

Get A Paginated List of Reports (GET/v1/reports)

Get Reports for an Asset (GET/v1/reports/{id})