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

hello@vwd.ai

License

MIT

Languages
Servers
Mock server

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

VwD Production API Server

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

Creator Management

Endpoints related to creators information and searches.

Operations

Content Analysis

Endpoints for retrieving creators posts with labels.

Operations

Brand Mentions

Endpoints for creators posts and timelines related to brands.

Operations

Retrieve Creators Brand Timeline

Request

Public API Endpoint

Fetch a timeline of posts for a given creators mentioning a specific brand. The timeline groups posts by year and month. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
brand_idintegerrequired

ID of the brand to filter posts by.

curl -i -X GET \
  'https://apidocs.vwd.ai/_mock/apis/creators/{id}/brands-timeline/?brand_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Timeline of posts mentioning the brand, 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 a given brand. Optional filters for year and month can be applied. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
brand_idintegerrequired

ID of the brand.

yearinteger

Year filter for posts (optional).

monthinteger

Month filter for posts (optional).

curl -i -X GET \
  'https://apidocs.vwd.ai/_mock/apis/creators/{id}/brands-posts/?brand_id=0&month=0&year=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of posts mentioning the brand, with details.

Bodyapplication/jsonArray [
platform_namestring

Platform name where the post was published.

Example: "Instagram"
datestring(date)

Date of the post.

Example: "January 1, 2024"
linkstring

URL link to the post.

Example: "https://instagram.com/post/12345"
]
Response
application/json
[
  {
    "platform_name": "Instagram",
    "date": "January 1, 2024",
    "link": "https://instagram.com/post/12345"
  }
]

Compliance Monitoring

Endpoints for creators compliance data.

Operations