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

Resource: column_labels

...

http://{device}/api/npm.reports.sources/1.0/columns/items/{column_id}/labels
  • JSON
    • {
  "column": src_column_strings,
  "column_id": string
}
    Property Name Type Description Notes
    column_labels <object> ...
    column_labels.column <src_column_strings>
    column_labels.column_id <string> Optional;

    column_labels: get

    GET http://{device}/api/npm.reports.sources/1.0/columns/items/{column_id}/labels
    Response Body

    Returns a column_labels data object.

    Resource: columns_labels

    ...

    http://{device}/api/npm.reports.sources/1.0/columns/labels
  • JSON
    • {
  "columns": {
    <prop>: src_column_strings
  }
}
    Property Name Type Description Notes
    columns_labels <object> ...
    columns_labels.columns <object> Optional;
    columns_labels.columns.<prop> <src_column_strings>

    columns_labels: get

    GET http://{device}/api/npm.reports.sources/1.0/columns/labels
    Response Body

    Returns a columns_labels data object.

    Resource: field

    ...

    http://{device}/api/npm.reports.sources/1.0/fields/items/{id}
  • JSON
    • {
  "categories": [
    string
  ],
  "depends_on": [
    string
  ],
  "description": string,
  "enum": boolean,
  "enum_dup": string,
  "groups": [
    string
  ],
  "id": string,
  "identifier": boolean,
  "internal": boolean,
  "labels": {
    <prop>: string
  },
  "maximum": number,
  "metric": boolean,
  "minimum": number,
  "name": string,
  "precision": integer,
  "type": string,
  "unit": string
}
    Property Name Type Description Notes
    field <object> ...
    field.categories <array of <string>> Optional;
    field.categories[items] <string>
    field.depends_on <array of <string>> Optional;
    field.depends_on[items] <string>
    field.description <string> Optional;
    field.enum <boolean> Optional;
    field.enum_dup <string> Optional;
    field.groups <array of <string>> Optional;
    field.groups[items] <string>
    field.id <string> Optional;
    field.identifier <boolean> Optional;
    field.internal <boolean> Optional;
    field.labels <object> Optional;
    field.labels.<prop> <string> Optional;
    field.maximum <number> Optional;
    field.metric <boolean> Optional;
    field.minimum <number> Optional;
    field.name <string> Optional;
    field.precision <integer> Optional;
    field.type <string> Optional;
    field.unit <string> Optional;

    field: get

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

    Returns a field data object.

    Resource: fields

    ...

    http://{device}/api/npm.reports.sources/1.0/fields
  • JSON
    • {
}
    Property Name Type Description Notes
    fields <object> ...

    fields: get

    GET http://{device}/api/npm.reports.sources/1.0/fields
    Response Body

    Returns a fields data object.

    Resource: source

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{name}
  • JSON
    • {
  "capabilities": {
    "filters_on_metrics": boolean,
    <prop>: any
  },
  "columns": src_column_list,
  "granularities": [
    string
  ],
  "info": src_columns_info,
  "name": string
}
    Property Name Type Description Notes
    source <object> ... Required properties: [name, columns];
    source.capabilities <object> Optional;
    source.capabilities.filters_on_metrics <boolean> Are filters supported on metric columns Optional;
    source.capabilities.<prop> <any> Optional;
    source.columns <src_column_list>
    source.granularities <array of <string>> Optional;
    source.granularities[items] <string>
    source.info <src_columns_info>
    source.name <string>

    source: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{name}
    Response Body

    Returns a source data object.

    Resource: source_column

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns/items/{id}
  • JSON
    • {
  "area": string,
  "categories": [
    string
  ],
  "custom": boolean,
  "custom_id": string,
  "default_if_absent": string,
  "default_sort_direction": string,
  "description": string,
  "direction": string,
  "divisor_formula": string,
  "field": string,
  "field_description": string,
  "formula": string,
  "grouped_by": boolean,
  "groups": [
    string
  ],
  "id": string,
  "identifier": boolean,
  "items_type": string,
  "label": string,
  "maximum": integer,
  "metric": boolean,
  "minimum": integer,
  "operation": string,
  "precision": integer,
  "rate": string,
  "role": string,
  "searchable": boolean,
  "sortable": boolean,
  "source_name": string,
  "superseded_by": string,
  "supports_resample": boolean,
  "synthesized": {
    "depends_on": [
      string
    ],
    "method": string,
    "phase": string,
    "type": string
  },
  "topped_by": {
    "asc": boolean,
    "desc": boolean
  },
  "type": string,
  "unit": string
}
    Property Name Type Description Notes
    source_column <object> ... Required properties: [id, field, label];
    source_column.area <string> Whether the data is wan or lan related. Optional;
    source_column.categories <array of <string>> Organization categories that the column belongs to. Optional;
    source_column.categories[items] <string> Category to which the column belongs.
    source_column.custom <boolean> Whether the column has custom fields. Optional;
    source_column.custom_id <string> A custom column ID provided by the data source. Optional;
    source_column.default_if_absent <string> If no data is present, the value to use when plotting in a time-series chart Optional;
    source_column.default_sort_direction <string> Default sort direction (desc by default) Optional; Values: asc, desc;
    source_column.description <string> Description of the column Optional;
    source_column.direction <string> Direction of the data in the data type (server to client, member to peer, outbound, etc). Optional;
    source_column.divisor_formula <string> Divisor formula to use for statistical columns. Optional;
    source_column.field <string> Data field into which the column queries
    source_column.field_description <string> Description of the field Optional;
    source_column.formula <string> Formula to use for statistical columns such as weighted average. Optional;
    source_column.grouped_by <boolean> Whether the column can be used in the group-by parameter. Optional;
    source_column.groups <array of <string>> Optional;
    source_column.groups[items] <string>
    source_column.id <string> Addressable data colunm ID.
    source_column.identifier <boolean> Whether the column represents an entity ID. Optional;
    source_column.items_type <string> For array fields, the data type of the items in the array. Optional;
    source_column.label <string> Human-readable label for the column, to be used by the UI. May be internationalized
    source_column.maximum <integer> Maximum value for the column. Optional;
    source_column.metric <boolean> Whether it is a metric column Optional;
    source_column.minimum <integer> Minimum value for the column. Optional;
    source_column.operation <string> The operation that the field uses in aggregating (min, max, sum, etc). Optional;
    source_column.precision <integer> Decimal precision of the column data. Optional; Range: 0 to 32;
    source_column.rate <string> The rate at which the data type is measured (per second, per minute, etc). Optional;
    source_column.role <string> Role of the data type (server, caller, etc). Optional;
    source_column.searchable <boolean> Whether the column can be used in the npm.search API. Optional;
    source_column.sortable <boolean> Whether it is possible to sort on the column. Optional;
    source_column.source_name <string> Data source to which the column belongs. Optional;
    source_column.superseded_by <string> For a deprecated column, its replacement. Optional;
    source_column.supports_resample <boolean> Whether it supports resampling (true by default) Optional;
    source_column.synthesized <object> Details on how to synthesize the column based on other data. Required properties: [phase, type, depends_on]; Optional;
    source_column.synthesized.depends_on <array of <string>> Columns that the synthesis depends on.
    source_column.synthesized.depends_on
    [items]    		 <string>
    source_column.synthesized.method <string> The type that is being synthesized. Optional; Values: web_user, web_page_family, host_group, host_groups, app, apps, app_type, port_name;
    source_column.synthesized.phase <string> At which point in processing to synthesize the data. Values: firstrequest, everyrequest;
    source_column.synthesized.type <string> Type for a column with internally-synthesized values (e.g., IP synthesized to DNS Hostname) Values: custom, bool2name, enum2name, ip2dns, id2name, id2enum, sum, percent, ip2countrycode, ip2regioncode, ip2hostgroups, audit_details, violations_preview, tags, ip2netmask, ip2cidr;
    source_column.topped_by <object> Whether the column can be used in a top-query. Optional;
    source_column.topped_by.asc <boolean> Whether it can be topped by the column, ascending. Optional;
    source_column.topped_by.desc <boolean> Whether it can be topped by the column, descending. Optional;
    source_column.type <string> Data type of the column contents. Optional;
    source_column.unit <string> The unit of the data type being queried (bytes, percent, seconds). Optional;

    source_column: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns/items/{id}
    Response Body

    Returns a source_column data object.

    Resource: source_column_labels

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns/items/{column_id}/labels
  • JSON
    • {
  "column": src_column_strings,
  "column_id": string,
  "source_name": string
}
    Property Name Type Description Notes
    source_column_labels <object> ... Required properties: [items];
    source_column_labels.column <src_column_strings>
    source_column_labels.column_id <string> Optional;
    source_column_labels.source_name <string> Optional;

    source_column_labels: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns/items/{column_id}/labels
    Response Body

    Returns a source_column_labels data object.

    Resource: source_columns

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns
  • JSON
    • {
  "info": src_columns_info,
  "items": src_column_list,
  "source_name": string
}
    Property Name Type Description Notes
    source_columns <object> ... Required properties: [source_name, items];
    source_columns.info <src_columns_info>
    source_columns.items <src_column_list>
    source_columns.source_name <string>

    source_columns: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns
    Response Body

    Returns a source_columns data object.

    Resource: source_columns_labels

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns/labels
  • JSON
    • {
  "columns": {
    <prop>: src_column_strings
  },
  "source_name": string
}
    Property Name Type Description Notes
    source_columns_labels <object> ... Required properties: [column];
    source_columns_labels.columns <object> Optional;
    source_columns_labels.columns.<prop> <src_column_strings>
    source_columns_labels.source_name <string> Optional;

    source_columns_labels: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/columns/labels
    Response Body

    Returns a source_columns_labels data object.

    Resource: source_field

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/fields/items/{id}
  • JSON
    • {
  "field": field,
  "source_name": string
}
    Property Name Type Description Notes
    source_field <object> ...
    source_field.field <field> ...
    source_field.source_name <string> Optional;

    source_field: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/fields/items/{id}
    Response Body

    Returns a source_field data object.

    Resource: source_fields

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/fields
  • JSON
    • {
  "fields": fields,
  "source_name": string
}
    Property Name Type Description Notes
    source_fields <object> ...
    source_fields.fields <fields> ...
    source_fields.source_name <string> Optional;

    source_fields: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/fields
    Response Body

    Returns a source_fields data object.

    Resource: source_names

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/names
  • JSON
    • {
  "items": [
    string
  ]
}
    Property Name Type Description Notes
    source_names <object> ...
    source_names.items <array of <string>> Optional;
    source_names.items[items] <string>

    source_names: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/names
    Response Body

    Returns a source_names data object.

    Resource: source_restrictions

    ...

    http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/restrictions
  • JSON
    • {
  "items": [
    {
      "available_sets": [
        string
      ],
      "id": string
    }
  ],
  "source_name": string
}
    Property Name Type Description Notes
    source_restrictions <object> ... Required properties: [items];
    source_restrictions.items <array of <object>>
    source_restrictions.items[items] <object> Required properties: [id, available_sets];
    source_restrictions.items[items].
    available_sets    		 <array of <string>>
    source_restrictions.items[items].
    available_sets[items]    		 <string>
    source_restrictions.items[items].id <string>
    source_restrictions.source_name <string> Optional;

    source_restrictions: get

    GET http://{device}/api/npm.reports.sources/1.0/sources/items/{source_name}/restrictions
    Response Body

    Returns a source_restrictions data object.

    Resource: sources

    ...

    http://{device}/api/npm.reports.sources/1.0/sources
  • JSON
    • {
  "items": [ source ]
}
    Property Name Type Description Notes
    sources <object> ...
    sources.items <array of <source>> Optional;
    sources.items[items] <source> ...

    sources: get

    GET http://{device}/api/npm.reports.sources/1.0/sources
    Response Body

    Returns a sources data object.

    Type: src_column_list

    Property Name Type Description Notes
    src_column_list <array of <source_column>>
    src_column_list[items] <source_column> ...

    Type: src_column_strings

  • JSON
    • {
  "description": string,
  "field_description": string,
  "label": string,
  "labels": {
    <prop>: string
  },
  <prop>: any
}
    Property Name Type Description Notes
    src_column_strings <object>
    src_column_strings.description <string> Optional;
    src_column_strings.field_description <string> Optional;
    src_column_strings.label <string> Optional;
    src_column_strings.labels <object> Optional;
    src_column_strings.labels.<prop> <string> Optional;
    src_column_strings.<prop> <any> Optional;

    Type: src_columns_info

  • JSON
    • {
  "external_api_access": string,
  "generated_at": string,
  "vendor": string,
  "version": string,
  <prop>: any
}
    Property Name Type Description Notes
    src_columns_info <object> Required properties: [version, vendor, generated_at, external_api_access];
    src_columns_info.external_api_access <string> The value of this attribute indicates whether this data source should be used in end users' scripts. A value of "supported" indicates that resource is available for API-based use; a value "not_supported" indicates the opposite. API-based access to unsupported resources could cause the following problems: (a) Resource-specific APIs are not guaranteed to be present in future releases; (b) Using the API to interact with unsupported resources may also cause data processing gaps in the appliance. Values: not_supported, supported;
    src_columns_info.generated_at <string> Date/time when the source information was generated.
    src_columns_info.vendor <string> Name of vendor providing the data source.
    src_columns_info.version <string> Columns content version. If you are connecting to two devices and the returned columns are slightly different, please use this property to figure out which one is latest.
    src_columns_info.<prop> <any> Optional;