API Reference
/
Brand Mentions

VwD External API (1.0.0)

External API for accessing VwD creators data.

Download OpenAPI description
index.json
index.yaml
Overview
VwD API Support

support@vwd.ai

License

MIT

Languages
Servers
VwD Production API Server

https://api.vwd.ai/api/public/v1/

Mock server

https://apidocs.vwd.ai/_mock/apis/

Creator Management

Endpoints related to creators information and searches.

Operations

Brand Management

Endpoints for brand search and management.

Operations

List Management

Endpoints for managing creator lists.

Operations

Search

Full-text search endpoints powered by Elasticsearch.

Operations

Content Analysis

Endpoints for retrieving creators posts with labels.

Operations

Brand Mentions

Endpoints for creators posts and timelines related to brands.

Operations

Retrieve All Brands for a Specific Post

Request

Public API Endpoint

Fetch all brands mentioned in a specific post for a given creators. Returns brands sorted by mention count in descending order. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

post_idintegerrequired

ID of the post.

curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/creators/{id}/posts/{post_id}/brands/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of all brands mentioned in the post.

Bodyapplication/jsonArray [
idinteger

Brand ID.

Example: 1
namestring

Brand name.

Example: "nike"
countinteger

Number of times the brand is mentioned in the post.

Example: 3
]
Response
application/json
[
  {
    "id": 1,
    "name": "nike",
    "count": 3
  }
]

Retrieve Creators Brand Timeline

Request

Public API Endpoint

Fetch a timeline of posts for a given creators mentioning one or more brands. The timeline groups posts by year and month. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
brand_idsstringrequired

Comma-separated brand IDs (e.g., 123,456,789).

curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/creators/{id}/brands-timeline/?brand_ids=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Timeline of posts mentioning the brands, grouped by year and month.

Bodyapplication/jsonArray [
yearinteger

Year of the timeline.

Example: 2024
monthsArray of objects

List of months with active status.

]
Response
application/json
[
  {
    "year": 2024,
    "months": [ … ]
  }
]

Retrieve Creators Brand Posts

Request

Public API Endpoint

Fetch all posts for a specific creators mentioning one or more brands. Each post includes associated brands information with id, name, and count. Optional filters for year and month can be applied. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
brand_idsstringrequired

Comma-separated brand IDs (e.g., 123,456,789).

yearinteger

Year filter for posts (optional).

monthinteger

Month filter for posts (optional).

curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/creators/{id}/brands-posts/?brand_ids=string&month=0&year=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of posts mentioning the brands, with details and associated brands data.

Bodyapplication/jsonArray [
idinteger

Post ID.

Example: 12345
platform_namestring

Platform name where the post was published.

Example: "Instagram"
datestring

Date of the post.

Example: "January 1, 2024"
linkstring

URL link to the post.

Example: "https://instagram.com/post/12345"
scorenumber(float)

Normalized confidence score of the post.

Example: 95.5
reasonsArray of objects

Brand mention reasons for the post.

brandsArray of objects

Brands mentioned in the post with mention counts.

is_dismissedboolean

Whether the post has been dismissed.

Example: false
article_titlestring

Article title (Google News posts only).

image_urlstring

Image URL (Google News posts only).

article_textstring

Article text content (Google News and Reddit posts only).

source_namestring

Source name (Google News posts only).

]
Response
application/json
[
  {
    "id": 12345,
    "platform_name": "Instagram",
    "date": "January 1, 2024",
    "link": "https://instagram.com/post/12345",
    "score": 95.5,
    "reasons": [ … ],
    "brands": [ … ],
    "is_dismissed": false,
    "article_title": "string",
    "image_url": "string",
    "article_text": "string",
    "source_name": "string"
  }
]

Compliance Monitoring

Endpoints for creators compliance data.

Operations