Appearance
tag/rules
Lists tagging rules for one tag.
Method and path
GET /tag/rules/{project_id}/{tag_id}
Authentication
Authentication is required. See Authentication.
Permissions
Accessible to tier 1, 2, and 3 users.
Request headers
| Header | Required | Description |
|---|---|---|
X-Api-Key or X_API_KEY | yes | API key. |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | integer | yes | Project identifier. |
tag_id | integer | yes | Tag identifier. |
Example request
bash
curl "$SIGNAL_API_BASE_URL/tag/rules/<project_id>/<tag_id>" \
-H "X-Api-Key: $SIGNAL_API_KEY"Example response
json
{
"data": [
{
"rule_id": 789,
"tag": {
"id": 456,
"label": "Example Tag"
},
"tag_match_field": "post_text",
"tag_match_rule": "contains",
"tag_match_value": "example keyword"
}
]
}Response fields
| Field | Type | Description |
|---|---|---|
data | array<object> | Rule collection for the tag. |
Rule object fields
| Field | Type | Description |
|---|---|---|
rule_id | integer | Rule identifier. |
tag | object | Tag associated with the rule. |
tag_match_field | string | Matched field. |
tag_match_rule | string | Match operator or rule type. |
tag_match_value | string | Match value. |
Notes
- When no rules match, the endpoint returns
{"data": []}.