/hypeauditor | Type: Application | PCID required: Yes
Tools
hypeauditor_add_campaign_management_campaign_by_campaign_id_calendar
Add calendar record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
day | string | Yes | — | The day value |
influencer | string | Yes | — | influencer ID |
posts | integer | No | — | Posts count from influencer at day |
stories | integer | No | — | Stories count from influencer at day |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"day": {
"type": "string",
"description": "The day value"
},
"influencer": {
"type": "string",
"description": "influencer ID"
},
"posts": {
"type": "integer",
"description": "Posts count from `influencer` at `day`"
},
"stories": {
"type": "integer",
"description": "Stories count from `influencer` at `day`"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"day",
"influencer"
]
}
hypeauditor_add_campaign_management_campaign_by_campaign_id_columns
Add column Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
name | string | Yes | — | Column name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"name": {
"type": "string",
"description": "Column name"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"name"
]
}
hypeauditor_add_campaign_management_campaign_by_campaign_id_influencers
Add influencers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
influencers | object[] | Yes | — | The influencers value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"influencers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"social_type": {
"type": "integer",
"enum": [
1,
2,
3
],
"description": "Social network type. 1=instagram, 2=youtube, 3=tiktok"
},
"account_id": {
"type": "string",
"description": "Account Id"
}
}
},
"description": "The influencers value"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"influencers"
]
}
hypeauditor_add_campaign_management_campaign_by_campaign_id_mentions
Add tracking criteria Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
mentions | string[] | Yes | — | Array of mentions to add |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of mentions to add"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"mentions"
]
}
hypeauditor_add_campaign_management_campaign_by_campaign_id_posts
Add posts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
posts | string[] | Yes | — | array of posts links |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"posts": {
"type": "array",
"items": {
"type": "string"
},
"description": "array of posts links"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"posts"
]
}
hypeauditor_add_media_plan_plans_by_plan_id_accounts
Add accounts to media plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
accounts | object[] | Yes | — | Array of accounts to add |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"social_type": {
"type": "string",
"enum": [
"instagram",
"youtube",
"tiktok"
],
"description": "Social network type"
},
"social_id": {
"type": "string",
"description": "Social network account ID. At least one of social_id or username must be provided"
},
"username": {
"type": "string",
"description": "Account username. At least one of social_id or username must be provided"
}
},
"required": [
"social_type"
]
},
"description": "Array of accounts to add"
}
},
"required": [
"PCID",
"planId",
"accounts"
]
}
hypeauditor_create_campaign_management_campaign
Create campaignShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
hypeauditor_create_media_plan_plans
Create a media plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
title | string | No | — | Title for the new media plan (max 128 characters) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"title": {
"type": "string",
"description": "Title for the new media plan (max 128 characters)"
}
},
"required": [
"PCID"
]
}
hypeauditor_create_media_plan_plans_by_plan_id_events
Create media plan event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
social_id | string | Yes | — | Social network account ID |
social_type | string | Yes | — | Social network type |
type | string | Yes | — | Event type |
value | string | Yes | — | Event content (comment text) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"social_id": {
"type": "string",
"description": "Social network account ID"
},
"social_type": {
"type": "string",
"description": "Social network type",
"enum": [
"instagram",
"youtube",
"tiktok"
]
},
"type": {
"type": "string",
"description": "Event type",
"enum": [
"comment"
]
},
"value": {
"type": "string",
"description": "Event content (comment text)"
}
},
"required": [
"PCID",
"planId",
"social_id",
"social_type",
"type",
"value"
]
}
hypeauditor_create_report_check_unlock
Check unlock status for a list of reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
reports | object[] | Yes | — | List of influencer accounts to check (1–100 items) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"social_type": {
"type": "string",
"description": "Social network type"
},
"social_id": {
"type": "string",
"description": "Unique social network ID of the influencer"
},
"username": {
"type": "string",
"description": "Username of the influencer (used if social_id is not provided)"
}
},
"required": [
"social_type"
]
},
"description": "List of influencer accounts to check (1–100 items)"
}
},
"required": [
"PCID",
"reports"
]
}
hypeauditor_create_report_connections
Save creator social network connections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
connections | object[] | Yes | — | Array of social network accounts to link |
creator_id | string | Yes | — | Creator identifier from your system |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"social_type": {
"type": "string",
"description": "Social network type (instagram, youtube, tiktok, twitch, twitter, snapchat, facebook)"
},
"social_id": {
"type": "string",
"description": "User ID on the social network"
}
},
"required": [
"social_type",
"social_id"
]
},
"description": "Array of social network accounts to link"
},
"creator_id": {
"type": "string",
"description": "Creator identifier from your system"
}
},
"required": [
"PCID",
"connections",
"creator_id"
]
}
hypeauditor_create_social_listening_listeners
Create a social listening listener Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
social_types | string[] | Yes | — | Array of social networks to monitor (at least one required) |
type | string | Yes | — | Type of listener value |
value | string | Yes | — | The value to monitor. For ‘mention’ type: username without @. For ‘tag’ type: hashtag without #. For ‘keyword’ type: any text string. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"social_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"instagram",
"tiktok"
]
},
"description": "Array of social networks to monitor (at least one required)"
},
"type": {
"type": "string",
"description": "Type of listener value",
"enum": [
"mention",
"tag",
"keyword"
]
},
"value": {
"type": "string",
"description": "The value to monitor. For 'mention' type: username without @. For 'tag' type: hashtag without #. For 'keyword' type: any text string."
}
},
"required": [
"PCID",
"social_types",
"type",
"value"
]
}
hypeauditor_delete_campaign_management_campaign_by_campaign_id
Delete campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
}
},
"required": [
"PCID",
"CAMPAIGN_ID"
]
}
hypeauditor_delete_campaign_management_campaign_by_campaign_id_calendar
Delete calendar point Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
day | string | Yes | — | The day value |
influencer | string | Yes | — | influencer ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"day": {
"type": "string",
"description": "The day value"
},
"influencer": {
"type": "string",
"description": "influencer ID"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"day",
"influencer"
]
}
hypeauditor_delete_campaign_management_campaign_by_campaign_id_influencers
Delete influencers in campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
influencers | string[] | Yes | — | influencers to delete ids array |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"influencers": {
"type": "array",
"items": {
"type": "string"
},
"description": "influencers to delete ids array"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"influencers"
]
}
hypeauditor_delete_campaign_management_campaign_by_campaign_id_mentions
Delete tracking criteria Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
mentions | string[] | Yes | — | Array of mentions to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of mentions to delete"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"mentions"
]
}
hypeauditor_delete_campaign_management_campaign_by_campaign_id_posts
Delete posts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
posts | string[] | Yes | — | posts to delete ids array |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"posts": {
"type": "array",
"items": {
"type": "string"
},
"description": "posts to delete ids array"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"posts"
]
}
hypeauditor_delete_media_plan_plans_by_plan_id
Delete a media plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan identifier"
}
},
"required": [
"PCID",
"planId"
]
}
hypeauditor_delete_media_plan_plans_by_plan_id_accounts
Delete media plan accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
accounts | object[] | Yes | — | Array of accounts to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"social_type": {
"type": "string",
"enum": [
"instagram",
"youtube",
"tiktok"
],
"description": "Social network type"
},
"social_id": {
"type": "string",
"description": "Social network account ID"
}
},
"required": [
"social_type",
"social_id"
]
},
"description": "Array of accounts to delete"
}
},
"required": [
"PCID",
"planId",
"accounts"
]
}
hypeauditor_delete_media_plan_plans_by_plan_id_events_by_event_id
Delete media plan event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
eventId | string | Yes | — | Event unique identifier (UUID) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"eventId": {
"type": "string",
"description": "Event unique identifier (UUID)"
}
},
"required": [
"PCID",
"planId",
"eventId"
]
}
hypeauditor_get_campaign_management_campaign_by_campaign_id
Get campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
}
},
"required": [
"PCID",
"CAMPAIGN_ID"
]
}
hypeauditor_get_campaign_management_campaign_by_campaign_id_calendar
Calendar Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
}
},
"required": [
"PCID",
"CAMPAIGN_ID"
]
}
hypeauditor_get_campaign_management_campaign_by_campaign_id_posts
Get posts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
posts | string[] | Yes | — | Array of posts ids (from campaign object) |
sort | string | No | — | Sorting order, default is most_recent sort |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"posts": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of posts ids (from campaign object)"
},
"sort": {
"type": "string",
"description": "Sorting order, default is `most_recent` sort",
"enum": [
"most_recent",
"most_engaging",
"best_CPE"
]
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"posts"
]
}
hypeauditor_get_campaign_management_campaigns
Get a list of campaignsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
hypeauditor_get_look_alike_usernames
Get lookalike creator recommendations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
social_type | string | Yes | — | Social network type |
usernames[] | string[] | No | — | Array of usernames (required for Instagram and TikTok). Not used for YouTube. |
social_ids[] | string[] | No | — | Array of social network IDs (required for YouTube, e.g., channel IDs). Not used for Instagram/TikTok. |
page | integer | No | — | Page number for pagination |
limit | integer | No | — | Number of items per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"social_type": {
"type": "string",
"description": "Social network type",
"enum": [
"instagram",
"youtube",
"tiktok"
]
},
"usernames[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of usernames (required for Instagram and TikTok). Not used for YouTube."
},
"social_ids[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of social network IDs (required for YouTube, e.g., channel IDs). Not used for Instagram/TikTok."
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"limit": {
"type": "integer",
"description": "Number of items per page"
}
},
"required": [
"PCID",
"social_type"
]
}
hypeauditor_get_media_plan_plans
Get list of media plans Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of items per page |
order_by | string | No | — | Sort order for the results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of items per page"
},
"order_by": {
"type": "string",
"description": "Sort order for the results",
"enum": [
"events",
"created_at"
]
}
},
"required": [
"PCID"
]
}
hypeauditor_get_media_plan_plans_by_plan_id
Get a media plan by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
}
},
"required": [
"PCID",
"planId"
]
}
hypeauditor_get_media_plan_plans_by_plan_id_accounts
Get list of media plan accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
page | integer | No | — | Page number |
limit | integer | No | — | Number of items per page |
social_type | string | No | — | Filter by social network type |
social_id | string | No | — | Filter by social network account ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of items per page"
},
"social_type": {
"type": "string",
"description": "Filter by social network type",
"enum": [
"instagram",
"youtube",
"tiktok"
]
},
"social_id": {
"type": "string",
"description": "Filter by social network account ID"
}
},
"required": [
"PCID",
"planId"
]
}
hypeauditor_get_media_plan_plans_by_plan_id_creators
Get list of media plan creators Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
page | integer | No | — | Page number |
limit | integer | No | — | Number of items per page |
state | string | No | — | Filter by creator state |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"page": {
"type": "integer",
"description": "Page number"
},
"limit": {
"type": "integer",
"description": "Number of items per page"
},
"state": {
"type": "string",
"description": "Filter by creator state",
"enum": [
"in_review",
"accepted",
"rejected"
]
}
},
"required": [
"PCID",
"planId"
]
}
hypeauditor_get_media_plan_plans_by_plan_id_events
List of media plans events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
social_type | string | Yes | — | Social network type |
social_id | string | Yes | — | Social network account ID |
page | integer | No | — | Page number (default: 1) |
limit | integer | No | — | Items per page (default: 10, max: 100) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"social_type": {
"type": "string",
"description": "Social network type",
"enum": [
"instagram",
"youtube",
"tiktok"
]
},
"social_id": {
"type": "string",
"description": "Social network account ID"
},
"page": {
"type": "integer",
"description": "Page number (default: 1)"
},
"limit": {
"type": "integer",
"description": "Items per page (default: 10, max: 100)"
}
},
"required": [
"PCID",
"planId",
"social_type",
"social_id"
]
}
hypeauditor_get_media_plan_plans_by_plan_id_metrics
Get media plan metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
}
},
"required": [
"PCID",
"planId"
]
}
hypeauditor_get_social_listening_creators
Get list of creators from social listening Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
limit | integer | No | — | Number of items per page |
sort_order | string | No | — | Sort order by discovery date (asc - oldest first, desc - newest first) |
listener_id | string | No | — | Filter creators by specific listener ID. If not provided, returns creators from all listeners. |
with_disabled_listeners | boolean | No | — | Include creators from disabled listeners in results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"limit": {
"type": "integer",
"description": "Number of items per page"
},
"sort_order": {
"type": "string",
"description": "Sort order by discovery date (asc - oldest first, desc - newest first)",
"enum": [
"asc",
"desc"
]
},
"listener_id": {
"type": "string",
"description": "Filter creators by specific listener ID. If not provided, returns creators from all listeners."
},
"with_disabled_listeners": {
"type": "boolean",
"description": "Include creators from disabled listeners in results"
}
},
"required": [
"PCID"
]
}
hypeauditor_get_social_listening_creators_by_creator_id_mentions
Get creator mentions (posts) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
creator_id | integer | Yes | — | Creator unique identifier from the social listening creators list |
listener_id | string | No | — | Filter posts by specific listener ID. If not provided, returns all posts from all listeners for this creator. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"creator_id": {
"type": "integer",
"description": "Creator unique identifier from the social listening creators list"
},
"listener_id": {
"type": "string",
"description": "Filter posts by specific listener ID. If not provided, returns all posts from all listeners for this creator."
}
},
"required": [
"PCID",
"creator_id"
]
}
hypeauditor_get_social_listening_listeners
Get list of social listening listeners Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
limit | integer | No | — | Number of items per page (maximum 10) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"limit": {
"type": "integer",
"description": "Number of items per page (maximum 10)"
}
},
"required": [
"PCID"
]
}
hypeauditor_update_campaign_management_campaign_by_campaign_id
Update campaign data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
brief | string | No | — | The brief value |
currency | string | No | — | The currency value |
period | object | No | — | The period value |
state | string | No | — | The state value |
target | object | No | — | The target value |
title | string | No | — | The title value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"brief": {
"type": "string",
"description": "The brief value"
},
"currency": {
"type": "string",
"description": "The currency value",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"NZD",
"CAD",
"CHF",
"JPY",
"CZK",
"INR",
"BRL",
"TRY",
"HKD",
"RUB"
]
},
"period": {
"type": "object",
"description": "The period value",
"properties": {
"from": {
"type": "string",
"description": "Campaign start date. Pass `null` to unset."
},
"to": {
"type": "string",
"description": "Campaign end date. Pass `null` to unset."
}
}
},
"state": {
"type": "string",
"description": "The state value",
"enum": [
"ACTIVE",
"ARCHIVED"
]
},
"target": {
"type": "object",
"description": "The target value",
"properties": {
"reach": {
"type": "integer",
"description": "The reach value"
},
"impressions": {
"type": "integer",
"description": "The impressions value"
},
"engagement": {
"type": "integer",
"description": "The engagement value"
}
}
},
"title": {
"type": "string",
"description": "The title value"
}
},
"required": [
"PCID",
"CAMPAIGN_ID"
]
}
hypeauditor_update_campaign_management_campaign_by_campaign_id_columns_by_column
Update column data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
COLUMN | string | Yes | — | Сolumn id. Integer for custom column and string for default column [integration, status, payment_terms, payment_status, payout_details] |
influencer | string | Yes | — | Influencer id from campaign.features.accounts.data.*.basic.id field |
value | string | Yes | — | Value for influencer column |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"COLUMN": {
"type": "string",
"description": "Сolumn id. Integer for custom column and string for default column [integration, status, payment_terms, payment_status, payout_details]"
},
"influencer": {
"type": "string",
"description": "Influencer id from `campaign.features.accounts.data.*.basic.id` field"
},
"value": {
"type": "string",
"description": "Value for influencer column"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"COLUMN",
"influencer",
"value"
]
}
hypeauditor_update_campaign_management_campaign_by_campaign_id_columns_by_column_2
Update column Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
COLUMN | string | Yes | — | Edited column id |
name | string | Yes | — | Column name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"COLUMN": {
"type": "string",
"description": "Edited column id"
},
"name": {
"type": "string",
"description": "Column name"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"COLUMN",
"name"
]
}
hypeauditor_update_campaign_management_campaign_by_campaign_id_influencers
Update influencers in campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
influencers | object | Yes | — | Map of influencer_id to update fields. Each key is a unique influencer identifier in the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"influencers": {
"type": "object",
"description": "Map of influencer_id to update fields. Each key is a unique influencer identifier in the campaign."
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"influencers"
]
}
hypeauditor_update_campaign_management_campaign_by_campaign_id_posts_by_post_id
Update post data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CAMPAIGN_ID | string | Yes | — | campaign ID |
POST_ID | string | Yes | — | post ID |
clicks_count | integer | No | — | Clicks Count |
dms_count | integer | No | — | Dms Count |
impressions_count | integer | No | — | Impressions Count |
profile_visits_count | integer | No | — | Profile Visits Count |
reach | integer | No | — | The reach value |
reactions_count | integer | No | — | Reactions Count |
shares_count | integer | No | — | Shares Count |
sticker_taps_count | integer | No | — | Sticker Taps Count |
time_posted | string | No | — | Time Posted |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CAMPAIGN_ID": {
"type": "string",
"description": "campaign ID"
},
"POST_ID": {
"type": "string",
"description": "post ID"
},
"clicks_count": {
"type": "integer",
"description": "Clicks Count"
},
"dms_count": {
"type": "integer",
"description": "Dms Count"
},
"impressions_count": {
"type": "integer",
"description": "Impressions Count"
},
"profile_visits_count": {
"type": "integer",
"description": "Profile Visits Count"
},
"reach": {
"type": "integer",
"description": "The reach value"
},
"reactions_count": {
"type": "integer",
"description": "Reactions Count"
},
"shares_count": {
"type": "integer",
"description": "Shares Count"
},
"sticker_taps_count": {
"type": "integer",
"description": "Sticker Taps Count"
},
"time_posted": {
"type": "string",
"description": "Time Posted"
}
},
"required": [
"PCID",
"CAMPAIGN_ID",
"POST_ID"
]
}
hypeauditor_update_media_plan_plans_by_plan_id
Update a media plan Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier | |
config | object | No | — | Plan configuration object. If not provided - field will not be updated. If null is provided - null will be written. If provided, all nested fields (visibility, campaign, creators) are required. | |
description | string | null | No | — | Description for the media plan (max 10000 characters). If not provided - field will not be updated. If null is provided - null will be written. |
title | string | null | No | — | Title for the media plan (max 128 characters). If not provided - field will not be updated. If null is provided - null will be written. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"config": {
"type": "object",
"description": "Plan configuration object. If not provided - field will not be updated. If null is provided - null will be written. If provided, all nested fields (visibility, campaign, creators) are required.",
"properties": {
"visibility": {
"type": "object",
"description": "Visibility configuration for plan sections"
},
"campaign": {
"type": "object",
"description": "Campaign configuration data"
},
"creators": {
"type": "object",
"description": "Creators/influencers configuration"
}
}
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the media plan (max 10000 characters). If not provided - field will not be updated. If null is provided - null will be written."
},
"title": {
"type": [
"string",
"null"
],
"description": "Title for the media plan (max 128 characters). If not provided - field will not be updated. If null is provided - null will be written."
}
},
"required": [
"PCID",
"planId"
]
}
hypeauditor_update_media_plan_plans_by_plan_id_accounts
Update media plan accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
planId | string | Yes | — | Media plan unique identifier |
accounts | object[] | Yes | — | Array of accounts to update |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"planId": {
"type": "string",
"description": "Media plan unique identifier"
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"social_type": {
"type": "string",
"enum": [
"instagram",
"youtube",
"tiktok"
],
"description": "Social network type"
},
"social_id": {
"type": "string",
"description": "Social network account ID"
},
"media_plan_metrics": {
"type": "object",
"description": "Media plan metrics to update"
},
"report": {
"type": "object",
"description": "Manual report data overrides"
},
"state": {
"type": "string",
"enum": [
"in_review",
"accepted",
"rejected"
],
"description": "Account approval state"
}
},
"required": [
"social_type",
"social_id"
]
},
"description": "Array of accounts to update"
}
},
"required": [
"PCID",
"planId",
"accounts"
]
}

