apis » npm.probe.reports » 1.0
Report Manager API v1.0
Created Nov 12, 2024 at 09:56 PM

Resource: data_definition

A single data definition from a report instance

http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/items/{id}
  • JSON
    • {
  "act_as_source": boolean,
  "actual_centricity": string,
  "actual_filters": filter_criteria,
  "actual_source": data_def_source,
  "actual_time": {
    "granularities": [
      string
    ],
    "resolution": string,
    "time_ranges": time_pairs
  },
  "annotations": {
    <prop>: string
  },
  "available_columns": column_list,
  "centricity": string,
  "columns": column_list,
  "data": data_matrix,
  "datasource_id": string,
  "datasource_storage_key": string,
  "definition": data_definition,
  "filters": filter_criteria,
  "group_by": column_list,
  "id": integer,
  "limit": integer,
  "others": data_row,
  "reference_id": string,
  "report_id": integer,
  "source": data_def_source,
  "stats": {
    "completed": string,
    "created": string,
    "exec_time": string,
    "executing": string,
    "init_time": string,
    "initial_queue_pos": integer,
    "initialized": string,
    "initializing": string,
    "queue_time": string,
    "queued": string
  },
  "status": data_def_status,
  "subnet_by": {
    "mask_ipv4": integer,
    "mask_ipv6": integer
  },
  "summary_max_values": data_row,
  "summary_min_values": data_row,
  "synthetic": {
    "method": string,
    "sankey": {
      "levels": {
        <prop>: {
          "group_by": column_list,
          "limit": integer,
          "parent": string,
          <prop>: any
        }
      },
      <prop>: any
    }
  },
  "time": {
    "duration": string,
    "end": string,
    "fh_profile_id": integer,
    "granularity": string,
    "max_num_bins": integer,
    "offset": string,
    "optimal_num_bins": integer,
    "required_resolutions": [
      string
    ],
    "resolution": string,
    "retention_time": string,
    "start": string,
    "time_ranges": time_pairs,
    "timezone": string
  },
  "timeout": string,
  "top_by": [
    {
      "direction": string,
      "id": string,
      <prop>: any
    }
  ],
  "total_number_rows": integer,
  "totals": data_row,
  "ts_max_values": ts_statistical_results,
  "ts_min_values": ts_statistical_results,
  "ts_percentile_values": ts_statistical_results,
  "user_agent": string,
  "with_max_values": boolean,
  "with_min_values": boolean,
  "with_percentile_values": integer,
  "with_totals": boolean,
  <prop>: any
}
    Property Name Type Description Notes
    data_definition <object> A single data definition from a report instance Required properties: [source];
    data_definition.act_as_source <boolean> Make this object available to other data requests (using source.reference_id) Optional;
    data_definition.actual_centricity <string> Actual centricity used by the back-end data source. Used by network flow sources. When AUTO is requested, the back-end sets this to HOST or INTERFACE. Optional; Values: HOST, INTERFACE;
    data_definition.actual_filters <filter_criteria> Array of filter criteria.
    data_definition.actual_source <data_def_source> Data source specificiation for a data definition.
    data_definition.actual_time <object> Actual time frame returned by the data source based on data availability. Optional;
    data_definition.actual_time.
    granularities    		 <array of <string>> Array of actual granularities used in the query. Optional;
    data_definition.actual_time.
    granularities[items]    		 <string> Actual granularity used in the query.
    data_definition.actual_time.resolution <string> Actual resolution used in the query. Optional;
    data_definition.actual_time.time_ranges <time_pairs> Array of time range pairs.
    data_definition.annotations <object> Key-value pairs for statistical purposes Optional;
    data_definition.annotations.<prop> <string> Optional;
    data_definition.available_columns <column_list> Collection of data column IDs.
    data_definition.centricity <string> For network flow sources, this parameter hints the back-end to calculate metrics from hosts point of view or from interfaces point of view. Optional; Values: AUTO, HOST, INTERFACE;
    data_definition.columns <column_list> Collection of data column IDs.
    data_definition.data <data_matrix> Array of results data rows within a data definition.
    data_definition.datasource_id <string> Data source to which the data definition belongs. Globally unique within the system. Read-only; Optional;
    data_definition.datasource_storage_key <string> Location within the datasource in which data is stored Read-only; Optional;
    data_definition.definition <data_definition> A single data definition from a report instance
    data_definition.filters <filter_criteria> Array of filter criteria.
    data_definition.group_by <column_list> Collection of data column IDs.
    data_definition.id <integer> ID for the data definition. Unique within a single report instance. Read-only; Optional;
    data_definition.limit <integer> Limit returned data rows to the specified number. Optional;
    data_definition.others <data_row> Row of results data within a data definition.
    data_definition.reference_id <string> Corresponding data definition ID in the client system Optional;
    data_definition.report_id <integer> Report instance ID to which the data definition belogs. Optional;
    data_definition.source <data_def_source> Data source specificiation for a data definition.
    data_definition.stats <object> Overall statistics for a data definition. Read-only; Optional;
    data_definition.stats.completed <string> Date and time when the data definition execution was ended (regardless of final status). High-precision timestamp in Unix Epoch format. Read-only; Optional;
    data_definition.stats.created <string> Date and time when the data definition was created. High-precision timestamp in Unix Epoch format. Read-only; Optional;
    data_definition.stats.exec_time <string> The time it took to execute. High-precision duration (seconds). Read-only; Optional;
    data_definition.stats.executing <string> Date and time when the data definition started executing. High-precision timestamp in Unix Epoch format. Read-only; Optional;
    data_definition.stats.init_time <string> The time it took initialize. High-precision duration (seconds). Read-only; Optional;
    data_definition.stats.initial_queue_pos <integer> The queue position at the time it was first placed in the queue. Read-only; Optional;
    data_definition.stats.initialized <string> Deprecated and unused anymore. Read-only; Optional;
    data_definition.stats.initializing <string> Date and time when the data definition started initializing. High-precision timestamp in Unix Epoch format. Read-only; Optional;
    data_definition.stats.queue_time <string> The time it took waiting in the queue. High-precision duration (seconds). Read-only; Optional;
    data_definition.stats.queued <string> Date and time when the data definition was placed on the queue. High-precision timestamp in Unix Epoch format. Read-only; Optional;
    data_definition.status <data_def_status> Status for a data definition.
    data_definition.subnet_by <object> How to group IPs by subnet Required properties: [mask_ipv4, mask_ipv6]; Optional;
    data_definition.subnet_by.mask_ipv4 <integer> Subnet CIDR mask for IPv4 Addresses Range: 0 to 32;
    data_definition.subnet_by.mask_ipv6 <integer> Subnet CIDR mask for IPv6 Addresses Range: 0 to 128;
    data_definition.summary_max_values <data_row> Row of results data within a data definition.
    data_definition.summary_min_values <data_row> Row of results data within a data definition.
    data_definition.synthetic <object> Structure of a sythnetic definition Optional;
    data_definition.synthetic.method <string> Optional;
    data_definition.synthetic.sankey <object> Optional;
    data_definition.synthetic.sankey.levels <object> Optional;
    data_definition.synthetic.sankey.levels.
    <prop>    		 <object> Optional;
    data_definition.synthetic.sankey.levels.
    <prop>.group_by    		 <column_list> Collection of data column IDs.
    data_definition.synthetic.sankey.levels.
    <prop>.limit    		 <integer> Optional;
    data_definition.synthetic.sankey.levels.
    <prop>.parent    		 <string> Optional;
    data_definition.synthetic.sankey.levels.
    <prop>.<prop>    		 <any> Optional;
    data_definition.synthetic.sankey.<prop> <any> Optional;
    data_definition.time <object> The time frame that was requested for a reporting query. Optional;
    data_definition.time.duration <string> Time frame duration. When combined with either a start time or end time (but not both), determines the desired report time frame. If specified, and no start/end time is present, it is used with an end time of now. Optional;
    data_definition.time.end <string> The start time. This is a high-precision time value in Unix Epoch format. Optional;
    data_definition.time.fh_profile_id <integer> Business Hour Profile ID Optional; Minimum 1;
    data_definition.time.granularity <string> For sources that support multiple data granularity/rollup levels, the preferred granularity. If unspecified, the system will choose a granularity. Optional;
    data_definition.time.max_num_bins <integer> For auto-resolution, the maximum number of bins that the client supports. The system will not exceed this. Optional; Range: 1 to 20000;
    data_definition.time.offset <string> Offset the start/end time by the given amount (e.g., '5 min' to offset the start and end time back by 5 minutes). Optional;
    data_definition.time.optimal_num_bins <integer> For auto-resolution, the preferred number of bins for the client. The system will attempt to pick a resolution as close to this as possible. Optional; Range: 1 to 5000;
    data_definition.time.
    required_resolutions    		 <array of <string>> Array of resolutions. When auto-resolution is requested, the back end will limit its choice to one of these. Optional;
    data_definition.time.
    required_resolutions[items]    		 <string> A required resolution.
    data_definition.time.resolution <string> The requested resolution bin time-range for returned data (e.g., show in 1-hour bins). System will automatically pick if not specified. Optional;
    data_definition.time.retention_time <string> Specifies the time to retain data before rollint it off the query. Required for live data definitions. Optional;
    data_definition.time.start <string> The start time. This is a high-precision time value in Unix Epoch format. Optional;
    data_definition.time.time_ranges <time_pairs> Array of time range pairs.
    data_definition.time.timezone <string> Timezone name. Used for calculations when fh_profile_id is provided. Optional;
    data_definition.timeout <string> Maximum time within which to return data. Optional;
    data_definition.top_by <array of <object>> Array of sort criteria. Optional;
    data_definition.top_by[items] <object> A single sorting criterion, with direction.
    data_definition.top_by[items].direction <string> Direction in which to sort. Optional; Values: asc, desc;
    data_definition.top_by[items].id <string> ID to sort by Optional;
    data_definition.top_by[items].<prop> <any> Optional;
    data_definition.total_number_rows <integer> Total number of available data rows. Optional;
    data_definition.totals <data_row> Row of results data within a data definition.
    data_definition.ts_max_values <ts_statistical_results> Array of statistical result rows.
    data_definition.ts_min_values <ts_statistical_results> Array of statistical result rows.
    data_definition.ts_percentile_values <ts_statistical_results> Array of statistical result rows.
    data_definition.user_agent <string> User agent string for the client that generated the report. Read-only; Optional;
    data_definition.with_max_values <boolean> Whether to return column max value with the data results when querying. Optional;
    data_definition.with_min_values <boolean> Whether to return column min value with the data results when querying. Optional;
    data_definition.with_percentile_values <integer> Whether to return column percentile value with the data results when querying. Optional; Range: 80 to 95; Values: 80, 85, 90, 95;
    data_definition.with_totals <boolean> Whether to return column totals with the data results when querying. Optional;
    data_definition.<prop> <any> Optional;

    data_definition: delete

    Delete a single data definition from a report instance

    DELETE http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/items/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    data_definition: get

    Get a single data definition from a report instance

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/items/{id}
    Response Body

    Returns a data_definition data object.

    data_definition: get_data

    Get data definition data. For live data feeds, this will also trigger a data definition update.

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/items/{id}/data{?limit,offset,start_time,end_time,resolution,top_by,nsamples,sort_by,filter,columns,test_error,stream}
    Response Body

    Returns a data_def_results data object.

    data_definition: get_status

    Get the status for a single data definition from a report instance. For live data feeds, this will also trigger a data definition update.

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/items/{id}/status
    Response Body

    Returns a data_def_status data object.

    data_definition: set

    In a live report instance, update data for a single data definition

    PUT http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/items/{id}
    Request Body

    Provide a data_definition data object.

    Response Body

    Returns a data_definition data object.

    Resource: data_definitions

    Data definitions for a report instance

    http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs
  • JSON
    • {
  "items": data_defs_list,
  "report_id": integer
}
    Property Name Type Description Notes
    data_definitions <object> Data definitions for a report instance Required properties: [items];
    data_definitions.items <data_defs_list> Array of data definitions.
    data_definitions.report_id <integer> Report instance to which the data definitions belong. Optional;

    data_definitions: bulk_create

    Run multiple new data definition on an existing instance

    POST http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/bulk_create
    Request Body

    Provide a data_defs_list data object.

    Response Body

    Returns a data_defs_list data object.

    data_definitions: bulk_delete

    Delete multiple data definitions from an instance

    POST http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs/bulk_delete
    Request Body

    Provide a multiple_ids data object.

    Response Body

    Returns a multiple_ids data object.

    data_definitions: create

    Run a new data definition on an existing instance

    POST http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs
    Request Body

    Provide a data_definition data object.

    Response Body

    Returns a data_definition data object.

    data_definitions: get

    Get all data definitions for an instance

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/data_defs
    Response Body

    Returns a data_definitions data object.

    Resource: instance

    A single report instance

    http://{device}/api/npm.probe.reports/1.0/instances/items/{id}
  • JSON
    • {
  "access_rights": access_rights_obj,
  "created": string,
  "data_defs": data_defs_list,
  "id": integer,
  "idle_timeout": string,
  "info": report_instance_info,
  "last_modified": string,
  "live": boolean,
  "presentation": report_instance_presentation,
  "priority": string,
  "schedule_id": integer,
  "schedule_name": string,
  "template_id": integer,
  "template_name": string,
  "user_agent": string,
  "views": {
    "pdf": boolean,
    "raw_data": boolean
  },
  <prop>: any
}
    Property Name Type Description Notes
    instance <object> A single report instance Required properties: [data_defs];
    instance.access_rights <access_rights_obj> Specifies roles that have read/write access to an object. Users with read_write roles can read, update and delete the object. They can also share the object with other roles.
    instance.created <string> Date and time at which the report was created. High precision timestamp in Unix Epoch format. Optional;
    instance.data_defs <data_defs_list> Array of data definitions.
    instance.id <integer> ID of the report instance Read-only; Optional;
    instance.idle_timeout <string> Specifies the time to keep processing live data requests after last access (get info or get data). Optional;
    instance.info <report_instance_info> General information for a report instance
    instance.last_modified <string> Date and time at which the report was last modified. High precision timestamp in Unix Epoch format. Optional;
    instance.live <boolean> Whether the instance is a live (continuously updating) instance, rather than a static instance. Optional;
    instance.presentation <report_instance_presentation> Client presentation information for a report instance
    instance.priority <string> FUTURE - Report instance priority. Not yet used. Optional; Values: low, medium, high;
    instance.schedule_id <integer> Schedule ID which generated the report instance. Optional; Minimum 0;
    instance.schedule_name <string> Schedule name which generated the report instance. Optional;
    instance.template_id <integer> Template ID on which the report instance was based. Optional; Minimum 0;
    instance.template_name <string> Template name on which the report instance was based. Optional;
    instance.user_agent <string> User agent string for the client that generated the report. Read-only; Optional;
    instance.views <object> Indicates which views, PDF or JSON (raw), are available for an instance Required properties: [pdf, raw_data]; Optional;
    instance.views.pdf <boolean> Whether rendered PDF is available. Read-only;
    instance.views.raw_data <boolean> Whether raw JSON data is available. Read-only;
    instance.<prop> <any> Optional;

    instance: delete

    Delete a report instance

    DELETE http://{device}/api/npm.probe.reports/1.0/instances/items/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    instance: get

    Get a report instance. For live data feeds, this will also trigger an instance update to latest.

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{id}
    Response Body

    Returns an instance data object.

    instance: get_data

    Get data for all data definitions on an instance. For live data feeds, this will also trigger an instance update to latest.

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{id}/data
    Response Body

    On success, the server returns a response body with the following structure:

    Property Name Type Description Notes
    instance.links.get_data.response <object> Data for all data definitions within a report instance.
    instance.links.get_data.response.
    data_defs    		 <array of <data_def_results>> Array of data definition result sets. Optional;
    instance.links.get_data.response.
    data_defs[items]    		 <data_def_results> Data results for one data definition

    instance: get_rights

    Get the access rights for an instance

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{id}/access_rights
    Response Body

    Returns an access_rights_obj data object.

    instance: get_status

    Get status for all data definitions on an instance. For live data feeds, this will also trigger an instance update to latest.

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{id}/status
    Response Body

    On success, the server returns a response body with the following structure:

    Property Name Type Description Notes
    instance.links.get_status.response <array of <data_def_status>> Array of data definition statuses.
    instance.links.get_status.response
    [items]    		 <data_def_status> Status for a data definition.

    instance: get_view

    Download an instance as PDF. The only accepted content-type is application-pdf.

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{id}/view
    Response Body

    On success, the server does not provide any body in the responses.

    instance: replace_sync

    Update a report instance. This call will not return until the report completes.

    PUT http://{device}/api/npm.probe.reports/1.0/instances/items/{id}/sync
    Request Body

    Provide an instance data object.

    Response Body

    Returns an instance data object.

    instance: set

    Update a report instance

    PUT http://{device}/api/npm.probe.reports/1.0/instances/items/{id}
    Request Body

    Provide an instance data object.

    Response Body

    Returns an instance data object.

    instance: set_rights

    Update the access rights for an instance

    PUT http://{device}/api/npm.probe.reports/1.0/instances/items/{id}/access_rights
    Request Body

    Provide an access_rights_obj data object.

    Response Body

    On success, the server does not provide any body in the responses.

    instance: sync

    Get a report instance. If the instance is still running, this call will not return until it completes

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{id}/sync
    Response Body

    Returns an instance data object.

    Resource: instances

    Collection of report instances. When limiting results via query, all parameters must match a report instance for it to show.

    http://{device}/api/npm.probe.reports/1.0/instances{?sort,name,state,template_name,schedule_name,access_rights,access,schedule_id,tag,limit,sortby,offset,owner,template_id,description}
  • JSON
    • {
  "items": [ instance ],
  "meta": {
    "access": string,
    "access_rights": string,
    "count": integer,
    "description": string,
    "limit": integer,
    "name": string,
    "offset": integer,
    "owner": string,
    "schedule_id": string,
    "schedule_name": string,
    "sort": string,
    "sortby": string,
    "state": string,
    "tag": string,
    "template_id": string,
    "template_name": string,
    "total": integer
  }
}
    Property Name Type Description Notes
    instances <object> Collection of report instances. When limiting results via query, all parameters must match a report instance for it to show. Required properties: [items];
    instances.items <array of <instance>> Array of report instances
    instances.items[items] <instance> A single report instance
    instances.meta <object> Meta data of the data set returned when a list of reports are fetched. Optional;
    instances.meta.access <string> Filters instances based on access. "all", returns all instances that the current authenticated user has access to. "private", returns all instances not shared with any roles that the current authenticated user has access to. "shared", returns all instances shared with one or more roles. "public" returns all objects marked public. Optional; Values: all, private, shared, public;
    instances.meta.access_rights <string> Filters instances based on access_rights. "all", returns all instances with read_only or read_write rights that the authenticated user has access to. "read_only", returns all instances with read_only rights that the authenticated user has access to. "read_write", Returns all instances with read_write rights that the authenticated user has access to. Optional; Values: all, read_only, read_write;
    instances.meta.count <integer> The actual number of reports returned for this request. Optional;
    instances.meta.description <string> Filters report instances based on the description param passed. Does a case-insensitive substring match. Optional;
    instances.meta.limit <integer> Maximum number report instances to be returned. Optional;
    instances.meta.name <string> Filters report instances based on the name param passed. Does a case-insensitive substring match. Optional;
    instances.meta.offset <integer> Start returning report instances from offset specified. Optional;
    instances.meta.owner <string> Filters report instances based on the owner param passed. Does a case sensitive exact match of each owner, not a substring comparison of each owner. Owners can be passed as comma-separated values. Report instances with at least one of the owners passed in the query string will be matched. Optional;
    instances.meta.schedule_id <string> Filters report instances based on the schedule_id param passed. schedule_id can be passed as comma-separated values. Report instances with one of the schedule_ids passed in the query string param will be matched. Optional;
    instances.meta.schedule_name <string> Filters report instances based on the schedule_name param passed. Does a case-insensitive substring match. Optional;
    instances.meta.sort <string> Sort direction. Optional; Values: asc, desc;
    instances.meta.sortby <string> Sort by specified field. Optional; Values: name, description, owner, created, last_modified;
    instances.meta.state <string> Filter by specified state. Optional; Values: temporary, saved;
    instances.meta.tag <string> Filters report instances based on the tag param passed. Does a case-insensitive exact match of each tag, not a substring comparison of each tag. Tags can be passed as comma-separated values. Report instances with at least one of the passed tags will be matched. Optional;
    instances.meta.template_id <string> Filters report instances based on the template_id param passed. template_id can be passed as comma-separated values. Report instances with one of the template_ids passed in the query string param will be matched. Optional;
    instances.meta.template_name <string> Filters report instances based on the template_name param passed. Does a case-insensitive substring match. Optional;
    instances.meta.total <integer> Total number of reports in the system that match the filter criteria. Optional;

    instances: bulk_delete

    Bulk-delete multiple instances. Delete operation will be aborted and none of the instances will be deleted if the user does not have R/W access to any of the ids in the input list. Instance ids that do not exist (already deleted) will be ignored.

    POST http://{device}/api/npm.probe.reports/1.0/instances/bulk_delete
    Request Body

    Provide a request body with the following structure:

    Property Name Type Description Notes
    instances.links.bulk_delete.request <array of <integer>> Array of report instance IDs
    instances.links.bulk_delete.request
    [items]    		 <integer> Report instance ID
    Response Body

    On success, the server does not provide any body in the responses.

    instances: bulk_delete_matching

    Bulk-delete multiple instances. Delete operation will be aborted for the instances the user does not have R/W access to.

    POST http://{device}/api/npm.probe.reports/1.0/instances/bulk_delete_matching
    Request Body

    Provide a request body with the following structure:

    Property Name Type Description Notes
    instances.links.bulk_delete_matching.
    request    		 <object> Parameters to filter report instances
    instances.links.bulk_delete_matching.
    request.older_than    		 <string> High precision timestamp in Unix Epoch format. Matches report instances older than the provided timestamp. Optional;
    instances.links.bulk_delete_matching.
    request.schedule_id    		 <integer> Matches if the report instance was created as part of the specified schedule ID. Optional; Minimum 0;
    instances.links.bulk_delete_matching.
    request.template_id    		 <integer> Matches if the report instance is based on the specified template ID. Optional; Minimum 0;
    instances.links.bulk_delete_matching.
    request.user    		 <string> Performs a case-insensitive exact match against the owner of each report instance. Optional;
    Response Body

    On success, the server does not provide any body in the responses.

    instances: create

    Run a report asynchronously

    POST http://{device}/api/npm.probe.reports/1.0/instances
    Request Body

    Provide an instance data object.

    Response Body

    Returns an instance data object.

    instances: create_sync

    Run a report synchronously. This call will not return until the report completes.

    POST http://{device}/api/npm.probe.reports/1.0/instances/sync
    Request Body

    Provide an instance data object.

    Response Body

    Returns an instance data object.

    instances: get

    Get a list of report instances

    GET http://{device}/api/npm.probe.reports/1.0/instances{?sort,name,state,template_name,schedule_name,access_rights,access,schedule_id,tag,limit,sortby,offset,owner,template_id,description}
    Response Body

    Returns an instances data object.

    instances: get_tags

    Collect tags from all instances by owner

    GET http://{device}/api/npm.probe.reports/1.0/instances/tags
    Response Body

    Returns a rpt_tags data object.

    instances: refresh

    Request a saved snapshots disk utilization refresh. This operation is executed in the background, and should complete within a few seconds.

    POST http://{device}/api/npm.probe.reports/1.0/instances/snapshots_disk_usage/refresh
    Request Body

    Do not provide a request body.

    Response Body

    On success, the server does not provide any body in the responses.

    instances: snapshots_disk_usage

    Current quota and disk utilization of saved snapshots

    GET http://{device}/api/npm.probe.reports/1.0/instances/snapshots_disk_usage
    Response Body

    On success, the server returns a response body with the following structure:

    Property Name Type Description Notes
    instances.links.snapshots_disk_usage.
    response    		 <object> Current size and allowed quota of snapshots Required properties: [quota_size_kb, current_size_kb];
    instances.links.snapshots_disk_usage.
    response.current_size_kb    		 <integer> Current snapshots disk usage (collected hourly, or by manual update) Read-only;
    instances.links.snapshots_disk_usage.
    response.quota_size_kb    		 <integer> Maximum quota for all disk snapshots Read-only;

    instances: stream

    Run a report synchronously, streaming data from the data source. If the report does not complete within 50 seconds, it will return a 201 Created response, and the client must re-attach as with a synchronous request.

    POST http://{device}/api/npm.probe.reports/1.0/instances/stream
    Request Body

    Provide an instance data object.

    Response Body

    Returns an instance data object.

    Resource: report_instance_info

    General information for a report instance

    http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/info
  • JSON
    • {
  "description": string,
  "name": string,
  "report_id": integer,
  "state": string,
  "tags": tags_obj,
  <prop>: any
}
    Property Name Type Description Notes
    report_instance_info <object> General information for a report instance
    report_instance_info.description <string> Description of the report instance Optional;
    report_instance_info.name <string> Name of the report instance Optional;
    report_instance_info.report_id <integer> ID of the report instance Read-only; Optional;
    report_instance_info.state <string> Persistence state of the report instance Optional; Values: temporary, saved, transient;
    report_instance_info.tags <tags_obj> Container for a set of report tags.
    report_instance_info.<prop> <any> Optional;

    report_instance_info: get

    Get the report info for an instance

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/info
    Response Body

    Returns a report_instance_info data object.

    report_instance_info: set

    Replace the report info for an instance

    PUT http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/info
    Request Body

    Provide a report_instance_info data object.

    Response Body

    On success, the server does not provide any body in the responses.

    Resource: report_instance_presentation

    Client presentation information for a report instance

    http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/presentation
  • JSON
    • {
  "report_id": integer,
  <prop>: any
}
    Property Name Type Description Notes
    report_instance_presentation <object> Client presentation information for a report instance
    report_instance_presentation.report_id <integer> Instance ID to which the presentation belongs. Read-only; Optional;
    report_instance_presentation.<prop> <any> Optional;

    report_instance_presentation: get

    Get the presentation for an instance

    GET http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/presentation
    Response Body

    Returns a report_instance_presentation data object.

    report_instance_presentation: set

    Replace the presentation for an instance

    PUT http://{device}/api/npm.probe.reports/1.0/instances/items/{report_id}/presentation
    Request Body

    Provide a report_instance_presentation data object.

    Response Body

    On success, the server does not provide any body in the responses.

    Resource: schedule

    A single report schedule.

    http://{device}/api/npm.probe.reports/1.0/schedules/items/{id}
  • JSON
    • {
  "access_rights": access_rights_obj,
  "created": string,
  "enabled": boolean,
  "err_message": run_message,
  "execute_on": execution_timestamps,
  "executing": boolean,
  "executing_job_id": integer,
  "id": integer,
  "info": schedule_info,
  "last_executed": string,
  "last_modified": string,
  "notification_attachment_name": string,
  "notification_enabled": boolean,
  "notification_message": string,
  "num_instances": integer,
  "rrule": recurrence_rule,
  "subscription": {
    "recipient_ids": [
      integer
    ],
    "subscription_id": integer,
    "to": [
      string
    ],
    <prop>: any
  },
  "template_id": integer,
  "template_name": string,
  "time": {
    "duration": string,
    "fh_profile_id": integer,
    "snap_to_previous": string
  },
  <prop>: any
}
    Property Name Type Description Notes
    schedule <object> A single report schedule. Required properties: [enabled, info, template_id, rrule, time];
    schedule.access_rights <access_rights_obj> Specifies roles that have read/write access to an object. Users with read_write roles can read, update and delete the object. They can also share the object with other roles.
    schedule.created <string> Optional;
    schedule.enabled <boolean>
    schedule.err_message <run_message> Runtime status message for a data definition.
    schedule.execute_on <execution_timestamps> Report Schedule's next execution times in relative to the Unix Epoch format.
    schedule.executing <boolean> Flag indicating if the schedule is executing at the moment Read-only; Optional;
    schedule.executing_job_id <integer> Optional;
    schedule.id <integer> Read-only; Optional;
    schedule.info <schedule_info> Information on a scheduled report
    schedule.last_executed <string> Optional;
    schedule.last_modified <string> Optional;
    schedule.num_instances <integer> Number of snapshots already generated by this schedule Read-only; Optional;
    schedule.rrule <recurrence_rule> Recurrence rule specification for report schedule. Implements(incompletely) the Recurrence Rule Specification from iCalendar RFC - http://www.ietf.org/rfc/rfc2445.txt
    schedule.subscription <object> Optional;
    schedule.subscription.recipient_ids <array of <integer>> List of pre-defined recipient IDs. Optional;
    schedule.subscription.recipient_ids
    [items]    		 <integer>
    schedule.subscription.subscription_id <integer> Read-only; Optional;
    schedule.subscription.to <array of <string>> List of emails. Optional;
    schedule.subscription.to[items] <string>
    schedule.subscription.<prop> <any> Optional;
    schedule.template_id <integer>
    schedule.template_name <string> Name of the report template used for this schedule Read-only; Optional;
    schedule.time <object> Snapshot execution time range Required properties: [duration, snap_to_previous];
    schedule.time.duration <string> Lenght of time duration. Example: 1 hour.
    schedule.time.fh_profile_id <integer> Business Hour Profile ID Optional; Minimum 1;
    schedule.time.snap_to_previous <string> Calendar unit to snap the end of time range to. Values: NONE, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR;
    schedule.<prop> <any> Optional;
    schedule.notification_attachment_name <string>
    schedule.notification_enabled <boolean>
    schedule.notification_message <string>

    schedule: delete

    Delete a report schedule

    DELETE http://{device}/api/npm.probe.reports/1.0/schedules/items/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    schedule: get

    Get a report schedule

    GET http://{device}/api/npm.probe.reports/1.0/schedules/items/{id}
    Response Body

    Returns a schedule data object.

    schedule: set

    Update a report schedule

    PUT http://{device}/api/npm.probe.reports/1.0/schedules/items/{id}
    Request Body

    Provide a schedule data object.

    Response Body

    Returns a schedule data object.

    Resource: schedule_info

    Information on a scheduled report

    http://{device}/api/npm.probe.reports/1.0/schedules/items/{schedule_id}/info
  • JSON
    • {
  "description": string,
  "name": string,
  "schedule_id": integer,
  "tags": tags_obj,
  <prop>: any
}
    Property Name Type Description Notes
    schedule_info <object> Information on a scheduled report Required properties: [name];
    schedule_info.description <string> Optional;
    schedule_info.name <string>
    schedule_info.schedule_id <integer> Read-only; Optional;
    schedule_info.tags <tags_obj> Container for a set of report tags.
    schedule_info.<prop> <any> Optional;

    schedule_info: get

    Get the info for a scheduled report

    GET http://{device}/api/npm.probe.reports/1.0/schedules/items/{schedule_id}/info
    Response Body

    Returns a schedule_info data object.

    schedule_info: set

    Replace the info for a scheduled report

    PUT http://{device}/api/npm.probe.reports/1.0/schedules/items/{schedule_id}/info
    Request Body

    Provide a schedule_info data object.

    Response Body

    On success, the server does not provide any body in the responses.

    Resource: schedules

    List of scheduled reports

    http://{device}/api/npm.probe.reports/1.0/schedules{?sort,name,template_name,access_rights,access,tag,limit,sortby,offset,owner,template_id,description}
  • JSON
    • {
  "items": [ schedule ],
  "meta": {
    "access": string,
    "access_rights": string,
    "count": integer,
    "description": string,
    "limit": integer,
    "name": string,
    "offset": integer,
    "owner": string,
    "sort": string,
    "sortby": string,
    "tag": string,
    "template_id": string,
    "template_name": string,
    "total": integer
  }
}
    Property Name Type Description Notes
    schedules <object> List of scheduled reports Required properties: [items];
    schedules.items <array of <schedule>>
    schedules.items[items] <schedule> A single report schedule.
    schedules.meta <object> Meta data of the data set returned when a list of schedules are fetched. Optional;
    schedules.meta.access <string> Schedules filtered by this access param in the query string Optional;
    schedules.meta.access_rights <string> Schedules filtered by this access_rights param in the query string Optional;
    schedules.meta.count <integer> The actual number of rows returned as for this request. Optional;
    schedules.meta.description <string> Schedules filtered by this description param in the query string Optional;
    schedules.meta.limit <integer> The maximum number rows to return. 0 means no limit. Optional;
    schedules.meta.name <string> Schedules filtered by this name param in the query string Optional;
    schedules.meta.offset <integer> Number of schedules to be skipped as specified by offset. Offset value of 0 will be ignored. Optional;
    schedules.meta.owner <string> Schedules filtered by this owner param in the query string Optional;
    schedules.meta.sort <string> Schedules sorted on param in the query string Optional;
    schedules.meta.sortby <string> Schedules sorted by ascending or descending Optional;
    schedules.meta.tag <string> Schedules filtered by this tag/tags param in the query string Optional;
    schedules.meta.template_id <string> Optional;
    schedules.meta.template_name <string> Schedules filtered by this template name param in the query string Optional;
    schedules.meta.total <integer> Total number of rows that exists for the requested resource Optional;

    schedules: bulk_delete

    Bulk-delete multiple scheduled reports. Delete operation will be aborted and none of the schedules will be deleted if the user does not have R/W access to any of the ids in the input list. Schedule ids that do not exist will be ignored.

    POST http://{device}/api/npm.probe.reports/1.0/schedules/bulk_delete
    Request Body

    Provide a schedule_ids data object.

    Response Body

    Returns a schedule_ids data object.

    schedules: create

    Set up a scheduled report.

    POST http://{device}/api/npm.probe.reports/1.0/schedules{?sort,name,template_name,access_rights,access,tag,limit,sortby,offset,owner,template_id,description}
    Request Body

    Provide a schedule data object.

    Response Body

    Returns a schedule data object.

    schedules: execute_rrule

    For the given recurrence rule, calculate the corresponding schedule execution times.

    POST http://{device}/api/npm.probe.reports/1.0/schedules/execute_rrule
    Request Body

    Provide a recurrence_rule data object.

    Response Body

    Returns an execution_timestamps data object.

    schedules: export

    Get full version of all scheduled reports.

    GET http://{device}/api/npm.probe.reports/1.0/schedules/export
    Response Body

    Returns a schedules data object.

    schedules: get

    Get a list of scheduled reports.

    GET http://{device}/api/npm.probe.reports/1.0/schedules{?sort,name,template_name,access_rights,access,tag,limit,sortby,offset,owner,template_id,description}
    Response Body

    Returns a schedules data object.

    schedules: get_fhps

    Collect business hour profiles from all schedules

    GET http://{device}/api/npm.probe.reports/1.0/schedules/fh_profiles
    Response Body

    On success, the server returns a response body with the following structure:

    Property Name Type Description Notes
    schedules.links.get_fhps.response <object> Container for all business hour profiles in report schedules. Required properties: [items];
    schedules.links.get_fhps.response.items <array of <schd_fhp_obj>> Array of report schedule business hour profile.
    schedules.links.get_fhps.response.items
    [items]    		 <schd_fhp_obj> A single pair of report schedule and business hour profile.

    schedules: get_tags

    Collect tags from all schedules by owner

    GET http://{device}/api/npm.probe.reports/1.0/schedules/tags
    Response Body

    Returns a rpt_tags data object.

    Resource: template

    A single report template

    http://{device}/api/npm.probe.reports/1.0/templates/items/{id}
  • JSON
    • {
  "access_rights": access_rights_obj,
  "created": string,
  "id": integer,
  "info": template_info,
  "last_modified": string,
  "num_schedules": integer,
  "override": integer,
  <prop>: any
}
    Property Name Type Description Notes
    template <object> A single report template Required properties: [info];
    template.access_rights <access_rights_obj> Specifies roles that have read/write access to an object. Users with read_write roles can read, update and delete the object. They can also share the object with other roles.
    template.created <string> Optional;
    template.id <integer> Read-only; Optional;
    template.info <template_info> Information about a report template
    template.last_modified <string> Optional;
    template.num_schedules <integer> Number of schedules already generated by this template Optional;
    template.override <integer> Read-only; Optional;
    template.<prop> <any> Optional;

    template: delete

    Delete a report template

    DELETE http://{device}/api/npm.probe.reports/1.0/templates/items/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    template: get

    Get a report template

    GET http://{device}/api/npm.probe.reports/1.0/templates/items/{id}
    Response Body

    Returns a template data object.

    template: get_rights

    Get the access rights for a report template

    GET http://{device}/api/npm.probe.reports/1.0/templates/items/{id}/access_rights
    Response Body

    Returns an access_rights_obj data object.

    template: set

    Update a report template

    PUT http://{device}/api/npm.probe.reports/1.0/templates/items/{id}
    Request Body

    Provide a template data object.

    Response Body

    Returns a template data object.

    template: set_rights

    Update the access rights for a report template

    PUT http://{device}/api/npm.probe.reports/1.0/templates/items/{id}/access_rights
    Request Body

    Provide an access_rights_obj data object.

    Response Body

    On success, the server does not provide any body in the responses.

    Resource: template_info

    Information about a report template

    http://{device}/api/npm.probe.reports/1.0/templates/items/{template_id}/info
  • JSON
    • {
  "built_in": boolean,
  "client_source": string,
  "description": string,
  "name": string,
  "navigator": boolean,
  "overridden": boolean,
  "schedulable": boolean,
  "tags": tags_obj,
  "template_id": integer,
  "type": string,
  <prop>: any
}
    Property Name Type Description Notes
    template_info <object> Information about a report template Required properties: [name, client_source];
    template_info.built_in <boolean> Read-only; Optional;
    template_info.client_source <string> Values: ALLOY_CLIENT, WEB_UI;
    template_info.description <string> Optional;
    template_info.name <string>
    template_info.navigator <boolean> Optional;
    template_info.overridden <boolean> Read-only; Optional;
    template_info.schedulable <boolean> Optional;
    template_info.tags <tags_obj> Container for a set of report tags.
    template_info.template_id <integer> Read-only; Optional;
    template_info.type <string> Optional; Values: INTERACTIVE, DASHBOARD, REPORT, FAVORITES, HIDDEN;
    template_info.<prop> <any> Optional;

    template_info: get

    Get the info for a report template

    GET http://{device}/api/npm.probe.reports/1.0/templates/items/{template_id}/info
    Response Body

    Returns a template_info data object.

    template_info: set

    Replace the info for a report template

    PUT http://{device}/api/npm.probe.reports/1.0/templates/items/{template_id}/info
    Request Body

    Provide a template_info data object.

    Response Body

    On success, the server does not provide any body in the responses.

    Resource: templates

    List of system report templates

    http://{device}/api/npm.probe.reports/1.0/templates{?sort,schedulable,description,access_rights,client_source,access,tag,limit,sortby,offset,owner,built_in,type,navigator,name}
  • JSON
    • {
  "items": [ template ],
  "meta": {
    "access": string,
    "access_rights": string,
    "built_in": boolean,
    "client_source": string,
    "count": integer,
    "description": string,
    "limit": integer,
    "name": string,
    "navigator": boolean,
    "offset": integer,
    "owner": string,
    "schedulable": boolean,
    "sort": string,
    "sortby": string,
    "tag": string,
    "total": integer,
    "type": string
  }
}
    Property Name Type Description Notes
    templates <object> List of system report templates Required properties: [items];
    templates.items <array of <template>>
    templates.items[items] <template> A single report template
    templates.meta <object> Meta data of the data set returned when a list of templates are fetched. Optional;
    templates.meta.access <string> Templates filtered by this access param in the query string Optional;
    templates.meta.access_rights <string> Templates filtered by this access_rights param in the query string Optional;
    templates.meta.built_in <boolean> Templates filtered by this built_in param in the query string Optional;
    templates.meta.client_source <string> Templates filtered by this client_source param in the query string Optional;
    templates.meta.count <integer> The actual number of rows returned as for this request. Optional;
    templates.meta.description <string> Templates filtered by this description param in the query string Optional;
    templates.meta.limit <integer> The maximum number rows to return. 0 means no limit. Optional;
    templates.meta.name <string> Templates filtered by this name param in the query string Optional;
    templates.meta.navigator <boolean> Templates filtered by this navigator param in the query string Optional;
    templates.meta.offset <integer> Number of templates to be skipped as specified by offset. Offset value of 0 will be ignored. Optional;
    templates.meta.owner <string> Templates filtered by this owner param in the query string Optional;
    templates.meta.schedulable <boolean> Templates filtered by this schedulable param in the query string Optional;
    templates.meta.sort <string> Templates sorted on param in the query string Optional;
    templates.meta.sortby <string> Templates sorted by ascending or descending Optional;
    templates.meta.tag <string> Templates filtered by this tag/tags param in the query string Optional;
    templates.meta.total <integer> Total number of rows that exists for the requested resource Optional;
    templates.meta.type <string> Templates filtered by this type param in the query string Optional;

    templates: built_in_version

    Get the current version of built-in template content

    GET http://{device}/api/npm.probe.reports/1.0/templates/built_in_version
    Response Body

    On success, the server returns a response body with the following structure:

    Property Name Type Description Notes
    templates.links.built_in_version.
    response    		 <object>
    templates.links.built_in_version.
    response.version    		 <string> Optional;
    templates.links.built_in_version.
    response.<prop>    		 <any> Optional;

    templates: bulk_delete

    Bulk-delete multiple templates. Delete operation will be aborted and none of the templates will be deleted if the user does not have R/W access to any of the ids in the input list, or if the template a built-in template. template ids that do not exist will be ignored.

    POST http://{device}/api/npm.probe.reports/1.0/templates/bulk_delete
    Request Body

    Provide a template_ids data object.

    Response Body

    Returns a template_ids data object.

    templates: create

    Create a new report template

    POST http://{device}/api/npm.probe.reports/1.0/templates{?sort,schedulable,description,access_rights,client_source,access,tag,limit,sortby,offset,owner,built_in,type,navigator,name}
    Request Body

    Provide a template data object.

    Response Body

    Returns a template data object.

    templates: export

    Get full version of all report templates

    GET http://{device}/api/npm.probe.reports/1.0/templates/export
    Response Body

    Returns a templates data object.

    templates: get

    Get a list of report templates

    GET http://{device}/api/npm.probe.reports/1.0/templates{?sort,schedulable,description,access_rights,client_source,access,tag,limit,sortby,offset,owner,built_in,type,navigator,name}
    Response Body

    Returns a templates data object.

    templates: get_tags

    Collect tags from all templates by owner

    GET http://{device}/api/npm.probe.reports/1.0/templates/tags
    Response Body

    Returns a rpt_tags data object.

    Type: access_rights_obj

    Specifies roles that have read/write access to an object. Users with read_write roles can read, update and delete the object. They can also share the object with other roles.

  • JSON
    • {
  "effective": {
    "access_right": string,
    <prop>: any
  },
  "id": integer,
  "owner": string,
  "public": {
    "access_right": string,
    <prop>: any
  },
  "shared": {
    "read_only": roles_obj,
    "read_write": roles_obj,
    <prop>: any
  }
}
    Property Name Type Description Notes
    access_rights_obj <object> Specifies roles that have read/write access to an object. Users with read_write roles can read, update and delete the object. They can also share the object with other roles.
    access_rights_obj.effective <object> Provides a summary of user's access to the object. This is a read-only type. Required properties: [access_right]; Optional;
    access_rights_obj.effective.access_right <string> Value READ_WRITE implies that the user has read_write access on the object. READ_ONLY implies the user has read only access. NONE implies the user has no access to the object being requested. Read-only; Values: NONE, READ_ONLY, READ_WRITE;
    access_rights_obj.effective.<prop> <any> Optional;
    access_rights_obj.id <integer> Read-only; Optional;
    access_rights_obj.owner <string> Read-only; Optional;
    access_rights_obj.public <object> Indicates if an object/resource is public. All public objects/resouce are read_only. Required properties: [access_right]; Optional;
    access_rights_obj.public.access_right <string> Values: READ_ONLY;
    access_rights_obj.public.<prop> <any> Optional;
    access_rights_obj.shared <object> Property read_only - Specifies a list of roles that have read_only access to the resource/object. Property read_write - Specifies a list of roles that have read_write access to the resource/object. Optional;
    access_rights_obj.shared.read_only <roles_obj>
    access_rights_obj.shared.read_write <roles_obj>
    access_rights_obj.shared.<prop> <any> Optional;

    Type: column_list

    Collection of data column IDs.

  • JSON
    • [
  string
]
    Property Name Type Description Notes
    column_list <array of <string>> Collection of data column IDs.
    column_list[items] <string> Data column ID.

    Type: data_def_results

    Data results for one data definition

  • JSON
    • {
  "columns": column_list,
  "data": data_matrix,
  "datasource_id": string,
  "datasource_storage_key": string,
  "errors": run_messages,
  "id": integer,
  "meta": {
    "count": integer,
    "end_time": string,
    "filter": string,
    "filtered": integer,
    "limit": integer,
    "offset": integer,
    "resolution": string,
    "sort_by": string,
    "start_time": string,
    "total": integer
  },
  "others": data_row,
  "reference_id": string,
  "summary_max_values": data_row,
  "summary_min_values": data_row,
  "totals": data_row,
  "ts_max_values": ts_statistical_results,
  "ts_min_values": ts_statistical_results,
  "ts_percentile_values": ts_statistical_results
}
    Property Name Type Description Notes
    data_def_results <object> Data results for one data definition
    data_def_results.columns <column_list> Collection of data column IDs.
    data_def_results.data <data_matrix> Array of results data rows within a data definition.
    data_def_results.datasource_id <string> Data source to which the results belong. Read-only; Optional;
    data_def_results.datasource_storage_key <string> Location within the datasource in which data is stored Read-only; Optional;
    data_def_results.errors <run_messages> Array of runtime status messages for a data definition.
    data_def_results.id <integer> Data definition ID to which the results belong. Read-only; Optional;
    data_def_results.meta <object> Information about a data definition's data results. Optional;
    data_def_results.meta.count <integer> The number of data rows returned in the current results after filtering Optional;
    data_def_results.meta.end_time <string> The end time of a live data request. A high-precision time value, based on Unix Epoch time. Optional;
    data_def_results.meta.filter <string> A Steelfilter expression to filter results. Optional;
    data_def_results.meta.filtered <integer> Total number of data rows matching the filter. Optional;
    data_def_results.meta.limit <integer> The maximum number of data rows to return. 0 means no limit. Optional;
    data_def_results.meta.offset <integer> Skip the specified number of rows before starting to return data. Optional;
    data_def_results.meta.resolution <string> The resolution to use for a live data request. Optional;
    data_def_results.meta.sort_by <string> Sort by specified column. Format is a comma separated list, with a column id and direction for each entry (column_id1 desc,column_id2 asc) Optional;
    data_def_results.meta.start_time <string> The start time of a live data request. A high-precision time value, based on Unix Epoch time. Optional;
    data_def_results.meta.total <integer> Total number of available data rows. Optional;
    data_def_results.others <data_row> Row of results data within a data definition.
    data_def_results.reference_id <string> Corresponding data definition ID in the client system Read-only; Optional;
    data_def_results.summary_max_values <data_row> Row of results data within a data definition.
    data_def_results.summary_min_values <data_row> Row of results data within a data definition.
    data_def_results.totals <data_row> Row of results data within a data definition.
    data_def_results.ts_max_values <ts_statistical_results> Array of statistical result rows.
    data_def_results.ts_min_values <ts_statistical_results> Array of statistical result rows.
    data_def_results.ts_percentile_values <ts_statistical_results> Array of statistical result rows.

    Type: data_def_source

    Data source specificiation for a data definition.

  • JSON
    • {
  "name": string,
  "origin": string,
  "path": string,
  "reference_id": string,
  "tags": [
    string
  ],
  "type": string,
  <prop>: any
}
    Property Name Type Description Notes
    data_def_source <object> Data source specificiation for a data definition. Required properties: [name];
    data_def_source.name <string> Name of the data source for the data definition.
    data_def_source.origin <string> The origin data source for a query that is performing a sub-query into another data source (e.g., alerting requesting into system_metrics). Required in these cases for data column validation. Optional;
    data_def_source.path <string> Reference path to the requested data from within the data source. Optional;
    data_def_source.reference_id <string> Reference to another data_def which will be used as a source to this one. Optional;
    data_def_source.tags <array of <string>> Custom labels for this data source Optional;
    data_def_source.tags[items] <string>
    data_def_source.type <string> Data type requested Optional;
    data_def_source.<prop> <any> Optional;

    Type: data_def_status

    Status for a data definition.

  • JSON
    • {
  "datasource_id": string,
  "datasource_storage_key": string,
  "id": integer,
  "messages": run_messages,
  "progress": {
    "percent": integer,
    "processed_records": integer,
    "remaining_sec": integer,
    "total_records": integer
  },
  "reference_id": string,
  "state": string
}
    Property Name Type Description Notes
    data_def_status <object> Status for a data definition.
    data_def_status.datasource_id <string> Data source to which the data definition belongs. Read-only; Optional;
    data_def_status.datasource_storage_key <string> Location within the datasource in which data is stored Read-only; Optional;
    data_def_status.id <integer> Data definition ID to which the status belongs. Read-only; Optional;
    data_def_status.messages <run_messages> Array of runtime status messages for a data definition.
    data_def_status.progress <object> Details about the current progress of a running query. Optional;
    data_def_status.progress.percent <integer> Percentage of the total query that has been executed so far. Optional; Range: 0 to 100;
    data_def_status.progress.
    processed_records    		 <integer> Optional; Minimum 0;
    data_def_status.progress.remaining_sec <integer> Estimated number of seconds remaining in the query. Optional; Minimum 0;
    data_def_status.progress.total_records <integer> Optional; Minimum 0;
    data_def_status.reference_id <string> Corresponding data definition ID in the client system Read-only; Optional;
    data_def_status.state <string> Current execution state of the data definition. Optional; Values: pending, initializing, executing, completed, error, collecting;

    Type: data_defs_list

    Array of data definitions.

    Property Name Type Description Notes
    data_defs_list <array of <data_definition>> Array of data definitions.
    data_defs_list[items] <data_definition> A single data definition from a report instance

    Type: data_matrix

    Array of results data rows within a data definition.

  • JSON
    • [ data_row ]
    Property Name Type Description Notes
    data_matrix <array of <data_row>> Array of results data rows within a data definition.
    data_matrix[items] <data_row> Row of results data within a data definition.

    Type: data_row

    Row of results data within a data definition.

  • JSON
    • [
  string
]
    Property Name Type Description Notes
    data_row <array of <string>> Row of results data within a data definition.
    data_row[items] <string>

    Type: execution_timestamps

    Report Schedule's next execution times in relative to the Unix Epoch format.

  • JSON
    • [
  string
]
    Property Name Type Description Notes
    execution_timestamps <array of <string>> Report Schedule's next execution times in relative to the Unix Epoch format.
    execution_timestamps[items] <string>

    Type: filter_criteria

    Array of filter criteria.

  • JSON
    • [
  {
    "context": string,
    "id": string,
    "type": string,
    "value": string,
    <prop>: any
  }
]
    Property Name Type Description Notes
    filter_criteria <array of <object>> Array of filter criteria.
    filter_criteria[items] <object> A single filter criterion to use on the query data.
    filter_criteria[items].context <string> Context from which the filter was applied (e.g., user request, data drill-down, etc). Optional; Values: NONE, INTERNAL, USER, DRILL_DOWN;
    filter_criteria[items].id <string> Filter criterion ID. Optional;
    filter_criteria[items].type <string> The type of filter used on the data. Optional; Values: STEELFILTER, WIRESHARK, BPF;
    filter_criteria[items].value <string> Query filter text to use. Optional;
    filter_criteria[items].<prop> <any> Optional;

    Type: multiple_ids

    Array of IDs.

  • JSON
    • [
  integer
]
    Property Name Type Description Notes
    multiple_ids <array of <integer>> Array of IDs.
    multiple_ids[items] <integer> ID.

    Type: recurrence_rule

    Recurrence rule specification for report schedule. Implements(incompletely) the Recurrence Rule Specification from iCalendar RFC - http://www.ietf.org/rfc/rfc2445.txt

  • JSON
    • {
  "allow_past_times": boolean,
  "byday": [
    string
  ],
  "byhour": [
    integer
  ],
  "byminute": [
    integer
  ],
  "bymonth": [
    integer
  ],
  "bymonthday": [
    integer
  ],
  "bysecond": [
    integer
  ],
  "bysetpos": [
    integer
  ],
  "count": integer,
  "dtstart": string,
  "freq": string,
  "interval": integer,
  "timezone": string,
  "until": string
}
    Property Name Type Description Notes
    recurrence_rule <object> Recurrence rule specification for report schedule. Implements(incompletely) the Recurrence Rule Specification from iCalendar RFC - http://www.ietf.org/rfc/rfc2445.txt Required properties: [freq];
    recurrence_rule.allow_past_times <boolean> Allow calculating rules for times in the past. If not set, or set to false, the result rules will always be in the future regardless of what dtstart is passed. Optional;
    recurrence_rule.byday <array of <string>> Specifies days of the week. Optional;
    recurrence_rule.byday[items] <string> Values: SU, MO, TU, WE, TH, FR, SA;
    recurrence_rule.byhour <array of <integer>> Specifies hours of the day. Optional;
    recurrence_rule.byhour[items] <integer> Range: 0 to 23;
    recurrence_rule.byminute <array of <integer>> Specifies minutes within an hour. Optional;
    recurrence_rule.byminute[items] <integer> Range: 0 to 59;
    recurrence_rule.bymonth <array of <integer>> Specifies array of the months of the year. Optional;
    recurrence_rule.bymonth[items] <integer> Range: 1 to 12;
    recurrence_rule.bymonthday <array of <integer>> Specifies array of days of the month. 0 is invalid value. Optional;
    recurrence_rule.bymonthday[items] <integer> Range: -31 to 31;
    recurrence_rule.bysecond <array of <integer>> Specifies seconds within a minute. Optional;
    recurrence_rule.bysecond[items] <integer> Range: 0 to 59;
    recurrence_rule.bysetpos <array of <integer>> Specifies the nth occurrence within the set of events specified by the rule. 0 is invalid value. It MUST only be used in conjunction with another BYxxx rule part. Optional;
    recurrence_rule.bysetpos[items] <integer> Range: -366 to 366;
    recurrence_rule.count <integer> Specifies the number of occurrences, either until or count must be specified, but not both. Optional;
    recurrence_rule.dtstart <string> Specifies when the recurrence begins. High precision timestamp relative to the Unix Epoch. Optional;
    recurrence_rule.freq <string> Type of recurrence rule, to specify repeating events based on an interval of freq. Values: YEARLY, QUARTERLY, MONTHLY, WEEKLY, DAILY, HOURLY, ONETIME;
    recurrence_rule.interval <integer> Specifies how often the recurrence rule repeats. Optional;
    recurrence_rule.timezone <string> Specifies when the time zone. Example: Europe/Budapest. If not specified Etc/Universal is used. Optional;
    recurrence_rule.until <string> Specifies when the recurrence ends, either until or count must be specified, but not both. High precision timestamp relative to the Unix Epoch. Optional;

    Type: roles_obj

  • JSON
    • {
  "roles": [
    integer
  ],
  <prop>: any
}
    Property Name Type Description Notes
    roles_obj <object> Required properties: [roles];
    roles_obj.roles <array of <integer>>
    roles_obj.roles[items] <integer>
    roles_obj.<prop> <any> Optional;

    Type: rpt_tag_obj

    A single set of report tags.

  • JSON
    • {
  "owner": string,
  "tags": tags_obj,
  <prop>: any
}
    Property Name Type Description Notes
    rpt_tag_obj <object> A single set of report tags. Required properties: [owner, tags];
    rpt_tag_obj.owner <string> Owner of the tag set.
    rpt_tag_obj.tags <tags_obj> Container for a set of report tags.
    rpt_tag_obj.<prop> <any> Optional;

    Type: rpt_tags

    Container for all tag sets on a report instance.

  • JSON
    • {
  "items": [ rpt_tag_obj ]
}
    Property Name Type Description Notes
    rpt_tags <object> Container for all tag sets on a report instance. Required properties: [items];
    rpt_tags.items <array of <rpt_tag_obj>> Array of report instance tag sets.
    rpt_tags.items[items] <rpt_tag_obj> A single set of report tags.

    Type: run_message

    Runtime status message for a data definition.

  • JSON
    • {
  "details": {
    <prop>: string
  },
  "id": string,
  "module_id": string,
  "nested": run_message,
  "text": string,
  <prop>: any
}
    Property Name Type Description Notes
    run_message <object> Runtime status message for a data definition.
    run_message.details <object> Additional message details. Optional;
    run_message.details.<prop> <string> Optional;
    run_message.id <string> Machine-parsable message or error code. Optional;
    run_message.module_id <string> The system module that generated the message. Optional;
    run_message.nested <run_message> Runtime status message for a data definition.
    run_message.text <string> Message text. Optional;
    run_message.<prop> <any> Optional;

    Type: run_messages

    Array of runtime status messages for a data definition.

  • JSON
    • Property Name Type Description Notes
    run_messages <array of <run_message>> Array of runtime status messages for a data definition.
    run_messages[items] <run_message> Runtime status message for a data definition.

    Type: schd_fhp_obj

    A single pair of report schedule and business hour profile.

  • JSON
    • {
  "fh_profile_id": integer,
  "schedule_id": integer,
  "schedule_name": string,
  <prop>: any
}
    Property Name Type Description Notes
    schd_fhp_obj <object> A single pair of report schedule and business hour profile. Required properties: [schedule_id, fh_profile_id];
    schd_fhp_obj.fh_profile_id <integer> Business Hour Profile ID Minimum 1;
    schd_fhp_obj.schedule_id <integer> Read-only;
    schd_fhp_obj.schedule_name <string> Optional;
    schd_fhp_obj.<prop> <any> Optional;

    Type: schedule_ids

    Array of report schedule IDs.

  • JSON
    • [
  integer
]
    Property Name Type Description Notes
    schedule_ids <array of <integer>> Array of report schedule IDs.
    schedule_ids[items] <integer> Report schedule ID.

    Type: tags_obj

    Container for a set of report tags.

  • JSON
    • {
  "items": [
    string
  ],
  <prop>: any
}
    Property Name Type Description Notes
    tags_obj <object> Container for a set of report tags.
    tags_obj.items <array of <string>> Array of report tags. Optional;
    tags_obj.items[items] <string> Report tag.
    tags_obj.<prop> <any> Optional;

    Type: template_ids

    Array of report template IDs

  • JSON
    • [
  integer
]
    Property Name Type Description Notes
    template_ids <array of <integer>> Array of report template IDs
    template_ids[items] <integer> Report template ID

    Type: time_pairs

    Array of time range pairs.

  • JSON
    • [
  {
    "end": string,
    "start": string
  }
]
    Property Name Type Description Notes
    time_pairs <array of <object>> Array of time range pairs.
    time_pairs[items] <object> A time range pair, consisting of a start and end time. Required properties: [start, end];
    time_pairs[items].end <string> The ending time. This is a high-precision time value in Unix Epoch format.
    time_pairs[items].start <string> The start time. This is a high-precision time value in Unix Epoch format.

    Type: ts_statistical_results

    Array of statistical result rows.

  • JSON
    • [
  {
    "group_by": data_row,
    "metric": string,
    "value": string
  }
]
    Property Name Type Description Notes
    ts_statistical_results <array of <object>> Array of statistical result rows.
    ts_statistical_results[items] <object> One result from a statistical or compatibility function Required properties: [value, metric, group_by];
    ts_statistical_results[items].group_by <data_row> Row of results data within a data definition.
    ts_statistical_results[items].metric <string> The metric column ID
    ts_statistical_results[items].value <string> The result value