Skip to content
Changelog

Report a bug

Hypeauditor integration: operations for AI agents

Hypeauditor connects to Type.com as an integration. This page lists the 110 operations documented for Claude and Codex in Type.com: 62 read, 35 write, 13 destructive.

About Hypeauditor

HypeAuditor provides comprehensive influencer marketing solutions, offering tools for influencer discovery, analytics, and campaign management across multiple social media platforms.

Categories: Marketing & Social

How to connect Hypeauditor to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

110 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

110 operations listed.

Auto tracking

  • Read

    Auto-tracking settings

    Auto-tracking settings by campaign

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/auto-tracking

  • Write

    Add auto-tracking mentions

    Add auto-tracking mentions

    POST /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/auto-tracking

  • Destructive

    Delete auto-tracking mentions

    Delete auto-tracking mentions

    DELETE /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/auto-tracking

Campaigns

  • Read

    Get a list of campaigns

    Get a list of all user campaigns

    GET /api/v2/campaign-management/campaigns

  • Read

    Get campaign

    Get campaign by ID

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}

  • Read

    Get campaign (deprecated)

    Get campaign by ID

    GET /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/

  • Read

    Get a list of campaigns (deprecated)

    Get a list of all user campaigns

    GET /api/v1/campaign-management/campaigns/

  • Write

    Create campaign

    Create campaign

    POST /api/v2/campaign-management/campaigns

  • Write

    Update campaign by ID

    Update campaign

    PUT /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}

  • Write

    Create campaign (deprecated)

    Create campaign

    PUT /api/v1/campaign-management/campaign/

  • Write

    Update campaign data (deprecated)

    Update campaign data by ID

    POST /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/

  • Destructive

    Delete campaign

    Delete campaign by ID

    DELETE /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}

  • Destructive

    Delete campaign (deprecated)

    Delete campaign by ID

    DELETE /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/

Content

  • Read

    Get drafts

    Get drafts by campaign

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/drafts

  • Read

    Get post metrics

    Get post metrics

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/posts/{POST_ID}/metrics

  • Read

    Get posts

    Get posts by campaign

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/posts

  • Read

    Get recent posts

    Get recent posts by campaign

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/posts/recent

  • Write

    Edit post metrics

    Edit post metrics

    PUT /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/posts/{POST_ID}/metrics

  • Write

    Add posts

    Add posts to campaign

    POST /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/posts

  • Write

    Add story

    Add story to campaign

    POST /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/stories

  • Write

    Update story

    Update story from campaign

    POST /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/stories/{STORY_ID}

  • Destructive

    Delete posts

    Delete posts from campaign

    DELETE /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/posts

Influencers

  • Read

    Get influencers

    Get influencers by campaign

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/influencers

  • Read

    Search influencers

    Search influencers by query

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/influencers/search

  • Write

    Add influencers

    Add influencers to campaign

    POST /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/influencers

  • Write

    Start tracking influencers

    Start tracking influencers in socials

    POST /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/influencers/start-tracking

  • Write

    Update influencers in campaign (deprecated)

    Update influencers in campaign

    POST /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/influencers/

  • Write

    Add influencers (deprecated)

    Add influencers to campaign

    PUT /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/influencers/

  • Destructive

    Delete influencers in campaign

    Delete influencers in campaign

    DELETE /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/influencers

  • Destructive

    Delete influencers in campaign (deprecated)

    Delete influencers in campaign

    DELETE /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/influencers/

Report

  • Read

    Report audience

    Get campaign report audience data

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/audience

  • Read

    Report ecom

    Get campaign report ecom data

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/ecom

  • Read

    Report engagement

    Get campaign report engagement data

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/engagement

  • Read

    Report influencers

    Get campaign report influencers data

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/influencers

  • Read

    Report overview

    Get campaign report overview

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/overview

  • Read

    Report engagement growth

    Get campaign report engagement growth data

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/overview-engagement

  • Read

    Report posts

    Get campaign report posts data

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/posts

  • Read

    Report spendings

    Get campaign report spendings data

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/spendings

  • Read

    Check unlock status for a list of reports

    Returns the unlock status for each requested influencer report, identified by socialtype and socialid or username.

    POST /api/v1/report/check-unlock

  • Write

    Unlock report action

    Unlock report for credits

    GET /api/v2/campaign-management/campaigns/{CAMPAIGN_ID}/report/unlock

  • Write

    Save creator social network connections

    Links social network accounts (reports) to a creator. Used to associate Instagram, YouTube, TikTok and other platform accounts with a specific creator identifier.

    POST /api/v1/report/connections

  • Write

    Unlock emails for a list of creators

    Unlocks and returns email addresses for each requested creator, identified by socialtype and socialid. Spends unlock tokens when an email is unlocked.

    POST /api/v1/report/unlock-emails

Look Alike

  • Read

    Get lookalike creator recommendations

    Find similar creators accounts based on provided usernames or social IDs. Results are returned synchronously.

    GET /api/v1/look-alike/usernames

Social Listening

  • Read

    Get list of social listening listeners

    Retrieve a paginated list of all social listening listeners. Returns listeners with their current status, creator counts, and monitoring information.

    GET /api/v1/social-listening/listeners

  • Read

    Get creator mentions (posts)

    Retrieve all posts (mentions) from a specific creator discovered through social listening. Returns posts where the creator mentioned tracked usernames, hashtags, or keywords across Instagram and TikTok. Results can be optionally filtered by a specific listener.

    GET /api/v1/social-listening/creators/{creator_id}/mentions

  • Read

    Get list of creators from social listening

    Retrieve a paginated list of creators discovered through social listening. Returns creators who have mentioned tracked usernames, hashtags, or keywords across Instagram and TikTok. Results can be filtered by specific listener and sorted by discovery date.

    GET /api/v1/social-listening/creators

  • Write

    Create a social listening listener

    Create a new social listening listener to track mentions, hashtags, or keywords across Instagram and TikTok. The listener will continuously monitor the specified value and collect posts from creators who use it.

    POST /api/v1/social-listening/listeners

Media Plan

  • Read

    Get list of media plan accounts

    Returns a paginated list of creators’ social network accounts for a specific media plan

    GET /api/v1/media-plan/plans/{planId}/accounts

  • Read

    Get list of media plan creators

    Returns a paginated list of creators for a specific media plan, including their social network accounts in a compact format. Each creator may be associated with multiple social network accounts.

    GET /api/v1/media-plan/plans/{planId}/creators

  • Read

    List of media plans events

    Retrieves a paginated list of events for a specific social network account in a media plan.

    GET /api/v1/media-plan/plans/{planId}/events

  • Read

    Get list of media plans

    Returns a paginated list of media plans

    GET /api/v1/media-plan/plans

  • Read

    Get a media plan by ID

    Returns a single media plan with full details including configuration and creators states count

    GET /api/v1/media-plan/plans/{planId}

  • Read

    Get media plan metrics

    Returns aggregated metrics for a media plan including overall metrics and metrics broken down by social network (Instagram, YouTube, TikTok)

    GET /api/v1/media-plan/plans/{planId}/metrics

  • Write

    Add accounts to media plan

    Adds social network accounts to a specific media plan. Accepts up to 20 accounts per request

    POST /api/v1/media-plan/plans/{planId}/accounts

  • Write

    Update media plan accounts

    Updates accounts in a specific media plan. Accepts up to 20 accounts per request. All fields except socialtype and socialid are optional — only provided fields will be updated.

    PATCH /api/v1/media-plan/plans/{planId}/accounts

  • Write

    Create media plan event

    Creates a new comment event for a specific social network account in a media plan.

    POST /api/v1/media-plan/plans/{planId}/events

  • Write

    Create a media plan

    Creates a new media plan

    POST /api/v1/media-plan/plans

  • Write

    Update a media plan

    Updates an existing media plan with the provided data. All top-level fields are optional: if not provided - field will not be updated, if null is provided - null will be written.

    PATCH /api/v1/media-plan/plans/{planId}

  • Destructive

    Delete media plan accounts

    Deletes accounts from a specific media plan. Accepts up to 20 accounts per request. Accounts that are not found in the plan will be listed in the skipped array.

    DELETE /api/v1/media-plan/plans/{planId}/accounts

  • Destructive

    Delete media plan event

    Deletes a specific event from a media plan.

    DELETE /api/v1/media-plan/plans/{planId}/events/{eventId}

  • Destructive

    Delete a media plan

    Deletes a media plan by its identifier

    DELETE /api/v1/media-plan/plans/{planId}

Calendar

  • Read

    Calendar (deprecated)

    Get calendar data for campaign

    GET /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/calendar/

  • Write

    Add calendar record (deprecated)

    Plan influencer posts & stories count for calendar day

    PUT /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/calendar/

  • Destructive

    Delete calendar point (deprecated)

    Delete calendar point

    DELETE /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/calendar/

Tracking criteria

  • Write

    Add tracking criteria (deprecated)

    Add tracking criteria to campaign: mentions, hashtags, etc.

    PUT /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/mentions/

  • Destructive

    Delete tracking criteria (deprecated)

    Delete tracking criteria in campaign: mentions, hashtags, etc.

    DELETE /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/mentions/

Posts

  • Write

    Get posts (deprecated)

    Get posts in campaign by ids

    POST /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/posts/

  • Write

    Add posts (deprecated)

    Add posts to campaign by links

    PUT /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/posts/

  • Write

    Update post data (deprecated)

    Update post data - currently only for editing stories data like clicks, impressions, etc.

    POST /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/posts/{POST_ID}/

  • Destructive

    Delete posts (deprecated)

    Delete posts in campaign

    DELETE /api/v1/campaign-management/campaign/{CAMPAIGN_ID}/posts/

Auditor.suggester?search={search}&st={st}&excl St={excl St}

  • Read

    Get Suggester

    Requests to this endpoint return Suggester results.

    GET /api/method/auditor.suggester

Auditor.creators

  • Read

    Get Influencer Profile Info

    GET /auditor.creators

    GET /api/method/auditor.creators

Auditor.report

  • Read

    Get Report Instagram by Username

    Requests to this endpoint return Instagram Report.

    GET /api/method/auditor.report

Auditor.report By User Id

  • Read

    Get Report Instagram by User ID

    Requests to this endpoint return Instagram Report.

    GET /api/method/auditor.reportByUserId

Auditor.report Media

  • Read

    Get Account Media

    Requests to this endpoint return Instagram Account Media.

    GET /api/method/auditor.reportMedia

Auditor.instagram History

  • Read

    Get Metrics History

    Requests to this endpoint return Instagram Metrics History.

    GET /api/method/auditor.instagramHistory

Auditor.youtube

  • Read

    Get Report YouTube

    Requests to this endpoint return YouTube Report.

    GET /api/method/auditor.youtube

Auditor.youtube Media

  • Read

    Get Account Media

    Requests to this endpoint return YouTube Account Media.

    GET /api/method/auditor.youtubeMedia

Auditor.youtube Brand Mentions

  • Read

    Get Brands Mentions

    Requests to this endpoint return YouTube Brands Mentions.

    GET /api/method/auditor.youtubeBrandMentions

Auditor.tiktok

  • Read

    Get Report TikTok by Username

    Requests to this endpoint return TikTok Report by a username (https://hypeauditor.readme.io/reference/reporttiktok).

    GET /api/method/auditor.tiktok

Auditor.tiktok By User Id

  • Read

    Get Report TikTok by User ID

    Requests to this endpoint return TikTok Report by user ID (https://hypeauditor.readme.io/reference/reporttiktok).

    GET /api/method/auditor.tiktokByUserId

Auditor.tiktok Media

  • Read

    Get Account Media

    Requests to this endpoint return TikTok Account Media.

    GET /api/method/auditor.tiktokMedia

Auditor.tiktok History

  • Read

    Get Metrics History

    Requests to this endpoint return TikTok Metrics History.

    GET /api/method/auditor.tiktokHistory

Auditor.tiktok Brand Mentions

  • Read

    Get Brands Mentions

    Requests to this endpoint return TikTok Brands Mentions.

    GET /api/method/auditor.tiktokBrandMentions

Auditor.twitter

  • Read

    Get Report Twitter

    Requests to this endpoint return Twitter Report.

    GET /api/method/auditor.twitter

Auditor.twitter History

  • Read

    Get Metrics History

    Requests to this endpoint return Twitter Metrics History.

    GET /api/method/auditor.twitterHistory

Auditor.twitch

  • Read

    Get Report Twitch

    Requests to this endpoint return Twitch Report.

    GET /api/method/auditor.twitch

Auditor.twitch History

  • Read

    Get Metrics History

    Requests to this endpoint return Twitch Metrics History.

    GET /api/method/auditor.twitchHistory

Auditor.snapchat

  • Read

    Get Snapchat Report

    Requests to this endpoint return Snapchat Report.

    GET /api/method/auditor.snapchat

Auditor.report Connections?username={username}&type={social network}

  • Read

    Get ReportConnections

    This endpoint collects all of the social accounts of an influencer's reports stored in the HypeAuditor database

    GET /api/method/auditor.reportConnections

Auditor.reports Unlocked?limit={limit}&date from={date from}&date to={date to}&offset={offset}

  • Read

    Get Unlocked Reports

    Requests to this endpoint return List of Unlocked Reports.

    GET /api/method/auditor.reportsUnlocked

Auditor.plan Info

  • Read

    Get Reports and Requests Left

    Requests to this endpoint return the number of analytical reports and discovery requests left in a subscription

    GET /api/method/auditor.planInfo

Auditor.search

  • Read

    Create a Search in Discovery

    Requests to this endpoint return Discovery Search.

    POST /api/method/auditor.search

Auditor.search Keywords Posts

  • Read

    Get Post Searching by Keywords

    Requests to this endpoint return Post Searching by Keywords.

    GET /api/method/auditor.searchKeywordsPosts

Auditor.taxonomy

  • Read

    Get Taxonomy v1

    Requests to this endpoint return Taxonomy.

    GET /api/method/auditor.taxonomy

Auditor.lists?id={id}&name={name}&count={count}&created={created}&updated={updated}

  • Read

    Get Lists

    Requests to this endpoint return Lists.

    GET /api/method/auditor.lists

Auditor.list?id={id}&limit={limit}&offset={offset}

  • Read

    Get List

    Requests to this endpoint return a specific List.

    GET /api/method/auditor.list

Auditor.add To List?list id={list id}&channel id={channel id}&type={type}

  • Write

    Add report to a list

    Requests to this endpoint add report to List.

    GET /api/method/auditor.addToList

Auditor.remove From List?report id={report id}&list id={list id}

  • Destructive

    Remove report from list

    Requests to this endpoint report report from List.

    GET /api/method/auditor.removeFromList

PDF export

  • Write

    Export Instagram report PDF

    Downloads an Instagram report as a PDF.

    GET /api/method/auditor.instagramPdf

  • Write

    Export YouTube report PDF

    Downloads a YouTube report as a PDF.

    GET /api/method/auditor.youtubePdf

  • Write

    Export TikTok report PDF

    Downloads a TikTok report as a PDF.

    GET /api/method/auditor.tiktokPdf

  • Write

    Export Twitter report PDF

    Downloads a Twitter (X) report as a PDF.

    GET /api/method/auditor.twitterPdf

  • Write

    Export Twitch report PDF

    Downloads a Twitch report as a PDF.

    GET /api/method/auditor.twitchPdf

  • Write

    Export Snapchat report PDF

    Downloads a Snapchat report as a PDF.

    GET /api/method/auditor.snapchatPdf

Discovery

  • Read

    Search influencers (sandbox)

    Runs a Discovery search against sandbox data for testing, without spending credits.

    POST /api/method/auditor.searchSandbox

  • Read

    Search Twitch games

    Searches Twitch game names for use as Discovery filters.

    GET /api/method/auditor.games

Market analysis

  • Read

    Get an Instagram competitor analysis

    Returns the results of an Instagram competitor analysis.

    GET /api/marketanalysis/instagramCompetitorAnalysis/{report_id}

  • Read

    Get competitor analysis posts

    Returns the posts included in an Instagram competitor analysis.

    POST /api/marketanalysis/instagramCompetitorAnalysis/posts

  • Write

    Create an Instagram competitor analysis

    Starts an Instagram competitor analysis for a set of brand accounts.

    POST /api/marketanalysis/instagramCompetitorAnalysis

See How connections work for access and permissions, or browse all integrations.