Stat API

Query for statistics

Statistic query format

KEY

TYPE

REQUIRED

DESC

resource_type

string

✅

Main resource type to select with grouping

query

dict

✅

Aggregate for grouping and its specification

join

list

❌

Joining resource which implements

formulas

list

❌

calculation for formula which stands

Full specification of Stat query

{
    "resource_type": ...,
    "query": {...},
    "join": [...],
    "formulas": [...]
}

{
    "resource_type": "identity.ServiceAccount",
    "query": {
        "aggregate": {
            "group": {
                "keys": [
                    {
                        "key": "provider",
                        "name": "provider"
                    },
                    {
                        "key": "service_account_id",
                        "name": "service_account_id"
                    },
                    {
                        "key": "name",
                        "name": "service_account_name"
                    }
                ]
            }
        },
        "sort": {
            "name": "resource_count",
            "desc": true
        },
        "limit": 5
    } 
}

query specification : (type: dict)

KEY

TYPE

REQUIRED

DESC

resource_type

string

✅

Main resource type to select with grouping

query

dict

✅

query for grouping statistic main select item

resource_type : "<service>.<resource>" 👉 identity.Project 👉 inventory.Server

query:

refer to statistic query specification

{
    "resource_type": ...,
    "query": ...,
    "join": [
        {
            "keys": [
                "service_account_id"   
            ],
            "resource_type": "inventory.Server",
            "query": {
                "aggregate": {
                    "unwind": [
                        {
                            "path": "collection_info.service_accounts"
                        }
                    ],
                    "group": {
                        "keys": [
                            {
                                "key": "service_account_id",
                                "name": "service_account_id"
                            }
                        ],
                        "fields": [
                            {
                                "operator": "count",
                                "name": "server_count"
                            }
                        ]
                    }
                }
            }
        },
        {
            "keys": [
                "service_account_id"
            ],
            "type": "RIGHT",
            "resource_type": "inventory.CloudService",
            "query": {
                "aggregate": {
                    "unwind": [
                        {
                            "path": "collection_info.service_accounts"
                        }
                    ],
                    "group": {
                        "keys": [
                            {
                                "key": "service_account_id",
                                "name": "service_account_id"
                            }
                        ],
                        "fields": [
                            {
                                "operator": "count",
                                "name": "cloud_service_count"
                            }
                        ]
                    }
                }
            }
        },
        {
            "keys": [
                "service_account_id"
            ],
            "type": "RIGHT",
            "resource_type": "secret.Secret",
            "query": {
                "aggregate": {
                    "group": {
                        "keys": [
                            {
                                "key": "service_account_id",
                                "name": "service_account_id"
                            }
                        ],
                        "fields": [
                            {
                                "operator": "count",
                                "name": "secret_count"
                            }
                        ]
                    }
                }
            }
        }
    ],
    "formulas": ...
}

Note: join has a dependencies on main resource_type, and query must pair with resource_type & query

join specification ( type: list )

KEY

TYPE

REQUIRED

DESC

keys

list

❌

Primary columns or keys to join with main resource of query and index join will be performed if keys hasn't given

type

string

❌

Type of join in SQL

LEFT (default)
RIGHT
INNER
OUTER

resource_type

string

✅

Resource type to join with

query

dict

✅

Select query for joining with primary resources

join_key:

refer to below images for each type's concept

query:

refer to statistic query specification

{
    "resource_type": ...,
    "query": ...,
    "join": ...,
    "formulas": [
        {
            "name": "resource_count",
            "formula": "server_count + cloud_service_count"
        }
    ]
}

Note: formulas has a dependencies on main resource_type, and query must pair with resource_type & query and join(if needed)

formula specification : ( type: list )

KEY

TYPE

REQUIRED

DESC

name

string

✅

name of variable that stores performed formula

formula

string

✅

algebraic formulas to calculate given form

operator

string

❌

optional values in EVAL(default), QUERY

formula use case

{
    "resource_type": ...,
    "query": ...,
    "join": ...,
    "formulas": [
        {
            "name": "total",
            "formula": "server_count + cloud_service_count"
        },
        { 
            "formula": "total > 0",
            "operator": "QUERY"
        }
    ]
}

Operator is OPTIONAL; Value EVAL(default) will be automatically set if there's no operator has not specifically declared in formula parameters.

Value Query has to be set to perform selective result as above within formulas.

Refers to - pandas.eval - pandas.DataFrame.query

PreviousEx.1 case: Project NextEx.1 case: Service Account

Last updated 5 years ago

{ "resource_type": ..., "query": ..., "join": [ { "keys": [ "service_account_id" ], "resource_type": "inventory.Server", "query": { "aggregate": { "unwind": [ { "path": "collection_info.service_accounts" } ], "group": { "keys": [ { "key": "service_account_id", "name": "service_account_id" } ], "fields": [ { "operator": "count", "name": "server_count" } ] } } } }, { "keys": [ "service_account_id" ], "type": "RIGHT", "resource_type": "inventory.CloudService", "query": { "aggregate": { "unwind": [ { "path": "collection_info.service_accounts" } ], "group": { "keys": [ { "key": "service_account_id", "name": "service_account_id" } ], "fields": [ { "operator": "count", "name": "cloud_service_count" } ] } } } }, { "keys": [ "service_account_id" ], "type": "RIGHT", "resource_type": "secret.Secret", "query": { "aggregate": { "group": { "keys": [ { "key": "service_account_id", "name": "service_account_id" } ], "fields": [ { "operator": "count", "name": "secret_count" } ] } } } } ], "formulas": ... }

hashtagStatistic query format

hashtagquery specification : (type: dict)

hashtagjoin specification ( type: list )

hashtagformula specification : ( type: list )

hashtagformula use case

Statistic query format

query specification : (type: dict)

join specification ( type: list )

formula specification : ( type: list )

formula use case