Get stream rule counts

Retrieves the count of rules in the active rule set for the filtered stream.

GET /2/tweets/search/stream/rules/counts

Try it

Get stream rule counts

cURL

curl --request GET \
  --url https://api.x.com/2/tweets/search/stream/rules/counts \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "all_project_client_apps": [
      {
        "client_app_id": "<string>",
        "rule_count": 123
      }
    ],
    "cap_per_client_app": 123,
    "cap_per_project": 123,
    "client_app_rules_count": {
      "client_app_id": "<string>",
      "rule_count": 123
    },
    "project_rules_count": 123
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

rules_count.fields · enum<string>[]

A comma separated list of RulesCount fields to display. The fields available for a RulesCount object.

Minimum array length: 1

Available options: all_project_client_apps, cap_per_client_app, cap_per_project, client_app_rules_count, project_rules_count

Example:

[
  "all_project_client_apps",
  "cap_per_client_app",
  "cap_per_project",
  "client_app_rules_count",
  "project_rules_count"
]

Response

200

application/json

The request has succeeded.

data · object

A count of user-provided stream filtering rules at the application and project levels.

Show child attributes

data. all_project_client_apps · object[]

Client App Rule Counts for all applications in the project

Show child attributes

data.all_project_client_apps. client_app_id · string

The ID of the client application

Required string length: 1 - 19

data.all_project_client_apps. rule_count · integer<int32>

Number of rules for client application

data. cap_per_client_app · integer<int32>

Cap of number of rules allowed per client application

data. cap_per_project · integer<int32>

Cap of number of rules allowed per project

data. client_app_rules_count · object

A count of user-provided stream filtering rules at the client application level.

Show child attributes

data.client_app_rules_count. client_app_id · string

The ID of the client application

Required string length: 1 - 19

data.client_app_rules_count. rule_count · integer<int32>

Number of rules for client application

data. project_rules_count · integer<int32>

Number of rules for project

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer