GET
/
feature-usage
curl --request GET \
  --url https://api.schematichq.com/feature-usage \
  --header 'X-Schematic-Api-Key: <api-key>'
{
  "data": [
    {
      "access": true,
      "allocation": 123,
      "allocation_type": "boolean",
      "entitlement_id": "<string>",
      "entitlement_type": "<string>",
      "feature": {
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "event_subtype": "<string>",
        "event_summary": {
          "company_count": 123,
          "environment_id": "<string>",
          "event_count": 123,
          "event_subtype": "<string>",
          "last_seen_at": "2023-11-07T05:31:56Z",
          "user_count": 123
        },
        "feature_type": "<string>",
        "flags": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "default_value": true,
            "description": "<string>",
            "feature": {
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "event_subtype": "<string>",
              "feature_type": "<string>",
              "id": "<string>",
              "lifecycle_phase": "<string>",
              "name": "<string>",
              "trait_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "feature_id": "<string>",
            "flag_type": "<string>",
            "id": "<string>",
            "key": "<string>",
            "latest_check": {
              "check_status": "<string>",
              "company_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "environment_id": "<string>",
              "error": "<string>",
              "flag_id": "<string>",
              "flag_key": "<string>",
              "id": "<string>",
              "reason": "<string>",
              "req_company": {},
              "req_user": {},
              "rule_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "user_id": "<string>",
              "value": true
            },
            "name": "<string>",
            "rules": [
              {
                "condition_groups": [
                  {
                    "conditions": [
                      {
                        "comparison_trait": {
                          "created_at": "2023-11-07T05:31:56Z",
                          "display_name": "<string>",
                          "entity_type": "<string>",
                          "hierarchy": [
                            "<string>"
                          ],
                          "id": "<string>",
                          "trait_type": "<string>",
                          "updated_at": "2023-11-07T05:31:56Z"
                        },
                        "comparison_trait_id": "<string>",
                        "condition_group_id": "<string>",
                        "condition_type": "<string>",
                        "created_at": "2023-11-07T05:31:56Z",
                        "environment_id": "<string>",
                        "event_subtype": "<string>",
                        "flag_id": "<string>",
                        "id": "<string>",
                        "metric_period": "<string>",
                        "metric_value": 123,
                        "operator": "<string>",
                        "plan_id": "<string>",
                        "resource_ids": [
                          "<string>"
                        ],
                        "resources": [
                          {
                            "id": "<string>",
                            "name": "<string>"
                          }
                        ],
                        "rule_id": "<string>",
                        "trait": {
                          "created_at": "2023-11-07T05:31:56Z",
                          "display_name": "<string>",
                          "entity_type": "<string>",
                          "hierarchy": [
                            "<string>"
                          ],
                          "id": "<string>",
                          "trait_type": "<string>",
                          "updated_at": "2023-11-07T05:31:56Z"
                        },
                        "trait_entity_type": "<string>",
                        "trait_id": "<string>",
                        "trait_value": "<string>",
                        "updated_at": "2023-11-07T05:31:56Z"
                      }
                    ],
                    "created_at": "2023-11-07T05:31:56Z",
                    "environment_id": "<string>",
                    "flag_id": "<string>",
                    "id": "<string>",
                    "plan_id": "<string>",
                    "rule_id": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z"
                  }
                ],
                "conditions": [
                  {
                    "comparison_trait": {
                      "created_at": "2023-11-07T05:31:56Z",
                      "display_name": "<string>",
                      "entity_type": "<string>",
                      "hierarchy": [
                        "<string>"
                      ],
                      "id": "<string>",
                      "trait_type": "<string>",
                      "updated_at": "2023-11-07T05:31:56Z"
                    },
                    "comparison_trait_id": "<string>",
                    "condition_group_id": "<string>",
                    "condition_type": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "environment_id": "<string>",
                    "event_subtype": "<string>",
                    "flag_id": "<string>",
                    "id": "<string>",
                    "metric_period": "<string>",
                    "metric_value": 123,
                    "operator": "<string>",
                    "plan_id": "<string>",
                    "resource_ids": [
                      "<string>"
                    ],
                    "resources": [
                      {
                        "id": "<string>",
                        "name": "<string>"
                      }
                    ],
                    "rule_id": "<string>",
                    "trait": {
                      "created_at": "2023-11-07T05:31:56Z",
                      "display_name": "<string>",
                      "entity_type": "<string>",
                      "hierarchy": [
                        "<string>"
                      ],
                      "id": "<string>",
                      "trait_type": "<string>",
                      "updated_at": "2023-11-07T05:31:56Z"
                    },
                    "trait_entity_type": "<string>",
                    "trait_id": "<string>",
                    "trait_value": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z"
                  }
                ],
                "created_at": "2023-11-07T05:31:56Z",
                "environment_id": "<string>",
                "flag_id": "<string>",
                "id": "<string>",
                "name": "<string>",
                "plan_id": "<string>",
                "priority": 123,
                "rule_type": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "value": true
              }
            ],
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "id": "<string>",
        "lifecycle_phase": "<string>",
        "name": "<string>",
        "plans": [
          {
            "id": "<string>",
            "image_url": "<string>",
            "name": "<string>"
          }
        ],
        "trait": {
          "created_at": "2023-11-07T05:31:56Z",
          "display_name": "<string>",
          "entity_type": "<string>",
          "hierarchy": [
            "<string>"
          ],
          "id": "<string>",
          "trait_type": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "trait_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "period": "<string>",
      "plan": {
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "id": "<string>",
        "name": "<string>",
        "plan_type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "usage": 123
    }
  ],
  "params": {
    "company_id": "<string>",
    "company_keys": {},
    "feature_ids": [
      "<string>"
    ],
    "limit": "100",
    "offset": "0",
    "q": "<string>"
  }
}

Authorizations

X-Schematic-Api-Key
string
headerrequired

Query Parameters

company_id
string
company_keys
object
feature_ids
string[]
q
string
limit
integer

Page limit (default 100)

offset
integer

Page offset (default 0)

Response

200 - application/json
data
object[]
required

The returned resources

params
object
required

Input parameters