Skip to main content

Query DB for Number of Sites that Match Query Params (v4.4)​

Queries the DB for limit number of sites that match the query parameters.

Path Parameters
    tenant_id string required

    The tenant ID.

Request Body

Query Details for the site

    aggregate Aggregate

    The aggregate number of sites that match the query parameters.

    data AggregateData[] required

    The details of the aggregate data.

  • Array [
    • value number required

    Value of the aggregate data.

    view object required

    View the aggregate date.

  • ]
    • field string

    Field

    name string required

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]

    Operator

    statistic string required

    QoS application aggregate statistics.

    unit string required

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number sites deleted for a time frame.

    group_by string[]

    Group By

    id string

    List the sites by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object
    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object
    total_count int64

    The total number of query parameters.

Responses

Successful Operation

Schema
    count int32

    The count of the query list.

    deleted_count int64

    The deleted number of queries.

    deleted_ids string[]

    The deleted query IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number of queries.

    items SiteQueryFilterV4N4[]
  • Array [
    • address Address

    The address of the site.

    city string

    The name of the city. Max size = 100.

    country string

    The name of the country. Max size = 100.

    post_code string

    The postal code. Max size = 100.

    state string

    The name of the state. Max size = 100.

    street string

    The name of the street. Max size = 100.

    street2 string

    The name of the street. Max size = 100.

    admin_state string

    The site mode of operation, can be in one of three states: Active - the site is in Control mode and network policy is applied. Monitor - the site is in Analytics mode, no network policy is applied. Disabled: the site is disabled.

    description

    Description for the site (Max size = 1024).

    element_cluster_role string

    This attribute describes the type i.e. SPOKE or HUB.

    id string

    The ID.

    location Location

    The geographical cordinates for the site address.

    description

    The decsription of the location.

    latitude float

    The latitude of the location. Max range = 90.

    longitude float

    The longitude of the location. Max range = 180.

    name string

    The site name (Max size = 128).

    nat_policysetstack_id string

    Nat Policysetstack Id

    network_policysetstack_id string

    The ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.

    policy_set_id string

    The ID for the Original Network Policy Set. Can be retrieved using policysets API.

    priority_policysetstack_id string

    ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.

    security_policyset_id string

    The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.

    service_binding string

    Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.

    tags string[]

    A information field that can be added to identify the site.

  • ]
Loading...