API Reference
/
Compliance Monitoring
/
Retrieve Creators Compliance Posts

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

Compliance Monitoring

Endpoints for creators compliance data.

Operations

Retrieve Creators Compliance Timeline

Request

Public API Endpoint

Fetch a timeline of compliance violations for a given creators. The response groups compliance violations by year and month. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
compliance_keystringrequired

Key for the compliance category to filter violations.

Enum"FTC""FINRA""Healthcare"
curl -i -X GET \
  'https://apidocs.vwd.ai/_mock/apis/creators/{id}/compliance-timeline/?compliance_key=FTC' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Timeline of compliance violations 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 Compliance Posts

Request

Public API Endpoint

Fetch all posts for a given creators with compliance violations. Optional filters for year and month can be applied. Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
compliance_keystringrequired

Key for the compliance category to filter violations.

Enum"FTC""FINRA""Healthcare"
yearinteger

Year filter for posts (optional).

monthinteger

Month filter for posts (optional).

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

Responses

List of posts with compliance violations.

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"
compliance_categoriesArray of strings

List of compliance categories associated with the post.

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