Skip to content

Latest commit

 

History

History
131 lines (82 loc) · 4.38 KB

ReportingApi.md

File metadata and controls

131 lines (82 loc) · 4.38 KB
Raw

{{classname}}

All URIs are relative to /

Method HTTP request Description
GetReportByName Get /reporting/report/{name} Retrieves a report by name.
GetReportFilters Get /reporting/reportFilters/{name} Retrieves report filters
GetReportStatus Get /reporting/status/{reportId} Retrieves status information for a report generation request based on the report ID
RunReport Post /reporting/report Run a report

GetReportByName

ReportResult GetReportByName(ctx, name, optional) Retrieves a report by name.

Retrieves a report by name in the desired format (CSV,PDF ,EXCEL). If the report is shared, add [shared:] before the name. This REST API command will be deprecated soon.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string The report name.
optional *ReportingApiGetReportByNameOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReportingApiGetReportByNameOpts struct

Name Type Description Notes

format | optional.String| |

Return type

ReportResult

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetReportFilters

RunReport GetReportFilters(ctx, name) Retrieves report filters

Retrieves report filters

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string The report name

Return type

RunReport

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetReportStatus

RunReportInfo GetReportStatus(ctx, reportId) Retrieves status information for a report generation request based on the report ID

Retrieves status information for a report generation request based on the report ID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
reportId string The ID of the report

Return type

RunReportInfo

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RunReport

RunReportInfo RunReport(ctx, body) Run a report

Sends a request to generate a report asynchronously and returns the request status. If the report is shared, add [shared:] before the name.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body RunReport The report generation parameters

Return type

RunReportInfo

Authorization

Bearer

HTTP request headers

  • Content-Type: /
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]