Get filters

Campaigns, platforms, content types and creators you can filter the old Home stats by.

GET /stats/filters

cURL

curl -X GET "https://api.growi.io/api/public/v1/stats/filters?start_date=01/01/2023&end_date=01/31/2023" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json"

200

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "campaign_id": 123,
        "name": "Summer Collection",
        "status": "active",
        "start_date": "2023-01-01",
        "end_date": "2023-01-31"
      },
      {
        "campaign_id": 124,
        "name": "Back to School",
        "status": "planned",
        "start_date": "2023-02-01",
        "end_date": "2023-02-28"
      }
    ],
    "platforms": [
      "instagram",
      "tiktok",
      "youtube",
      "facebook",
      "twitter"
    ],
    "content_types": [
      "video",
      "image",
      "carousel",
      "story",
      "reel"
    ],
    "creators": [
      {
        "creator_id": 1001,
        "name": "Jane Smith",
        "username": "@janesmith"
      },
      {
        "creator_id": 1002,
        "name": "John Doe",
        "username": "@johndoe"
      }
    ],
    "total_filters": 4
  }
}

Deprecated. This is one of the old Home stats endpoints. It still works, but new integrations should use the faster endpoints. Use Content filters (GET /content/filters). Responses carry Deprecation and Link headers. It takes MM/DD/YYYY dates; the new endpoints take ISO 8601 (YYYY-MM-DD). See deprecations.

Retrieves available filters for your organization within a specified date range.

​

Request parameters

Parameter	Type	Description	Required
start_date	String	Start date in MM/DD/YYYY format	Yes
end_date	String	End date in MM/DD/YYYY format	Yes
limit	Integer	Limit the number of results. Default is 4. Recommended is 20. Set to 10,000 to get all data.	No

​

Request example

curl -X GET "https://api.growi.io/api/public/v1/stats/filters?start_date=01/01/2023&end_date=01/31/2023" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json"

​

Response example

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "campaign_id": 123,
        "name": "Summer Collection",
        "status": "active",
        "start_date": "2023-01-01",
        "end_date": "2023-01-31"
      },
      {
        "campaign_id": 124,
        "name": "Back to School",
        "status": "planned",
        "start_date": "2023-02-01",
        "end_date": "2023-02-28"
      }
    ],
    "platforms": [
      "instagram",
      "tiktok",
      "youtube",
      "facebook",
      "twitter"
    ],
    "content_types": [
      "video",
      "image",
      "carousel",
      "story",
      "reel"
    ],
    "creators": [
      {
        "creator_id": 1001,
        "name": "Jane Smith",
        "username": "@janesmith"
      },
      {
        "creator_id": 1002,
        "name": "John Doe",
        "username": "@johndoe"
      }
    ],
    "total_filters": 4
  }
}

cURL

curl -X GET "https://api.growi.io/api/public/v1/stats/filters?start_date=01/01/2023&end_date=01/31/2023" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json"

200

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "campaign_id": 123,
        "name": "Summer Collection",
        "status": "active",
        "start_date": "2023-01-01",
        "end_date": "2023-01-31"
      },
      {
        "campaign_id": 124,
        "name": "Back to School",
        "status": "planned",
        "start_date": "2023-02-01",
        "end_date": "2023-02-28"
      }
    ],
    "platforms": [
      "instagram",
      "tiktok",
      "youtube",
      "facebook",
      "twitter"
    ],
    "content_types": [
      "video",
      "image",
      "carousel",
      "story",
      "reel"
    ],
    "creators": [
      {
        "creator_id": 1001,
        "name": "Jane Smith",
        "username": "@janesmith"
      },
      {
        "creator_id": 1002,
        "name": "John Doe",
        "username": "@johndoe"
      }
    ],
    "total_filters": 4
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

start_date · string · required

Start date (MM/DD/YYYY)

end_date · string · required

End date (MM/DD/YYYY)

organization_id · integer

A child brand of your organization

campaign_id · string

One campaign id or a comma-separated list

Response

200

application/json

Available filters

success · boolean

data · object