Appearance
project/single
Returns one project with aggregate counters.
Method and path
GET /project/single/{project_id}
Authentication
Authentication is required. See Authentication.
Permissions
Accessible to tiers 1, 2, 3, and 4.
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. |
Example request
bash
curl "$SIGNAL_API_BASE_URL/project/single/<project_id>" \
-H "X-Api-Key: $SIGNAL_API_KEY"Example response
json
{
"data": [
{
"id": 123,
"name": "Example Project",
"label": "example_project",
"description": "Project used in API examples",
"has_alerting": 1,
"masterindex_threshold": 0,
"has_autosentiment": 0,
"has_engagement_updates": 1,
"posts": "1.2K",
"posts_numeric": 1200,
"thumbnail": "https://cdn.example.com/example-thumbnail.jpg",
"jobs": 3,
"users": 5
}
]
}Response fields
| Field | Type | Description |
|---|---|---|
data | array<object> | Single-item array containing the project payload. |
Project object fields
| Field | Type | Description |
|---|---|---|
id | integer | Project identifier. |
name | string | null |
label | string | null |
description | string | null |
has_alerting | integer | boolean |
masterindex_threshold | integer | null |
has_autosentiment | integer | boolean |
has_engagement_updates | integer | boolean |
posts | string | integer |
posts_numeric | integer | Numeric posts count. |
thumbnail | string | Thumbnail URL or placeholder path. |
jobs | integer | Number of linked jobs. |
users | integer | Number of linked users. |
Notes
- The endpoint returns one project object inside
data, not as a top-level object.