Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AdminService
  • /admin/add-profile
  • /admin/delete-profile
  • /admin/detectwebsite
  • /admin/free-users
  • /admin/max-profiles
  • /admin/other-free-connections
  • /admin/profile
  • /admin/profiles
  • /admin/profiles-auth
  • /admin/report-logo
  • /admin/restore-profile
  • /admin/update-label-blog
  • /admin/blog/profiles
  • /admin/profile/getproperty
  • /admin/profile/setproperty
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
AdsService
  • /ads/adgroups
  • /ads/ads
  • /ads/base64tourl
  • /ads/campaigns
  • /ads/change/budget
  • /ads/change/status
  • /ads/create/campaign
  • /ads/engaging/images
  • /ads/fbads/adpreview
  • /ads/fbads/customevents
  • /ads/fbads/pixels
  • /ads/fbads/potentialreach
  • /ads/gads/forecast
  • /ads/gads/keywords
  • /ads/gads/qualityscore
  • /ads/gads/recommendations
  • /ads/user/currency
  • /ads/demographic/age/suggestion
  • /ads/demographic/gender/suggestion
  • /ads/demographic/location/suggestion
  • /ads/fbads/upload/video
  • /ads/gads/audience/suggestions
  • /ads/gads/keywords/suggestions
  • /ads/gads/recommendations/{recommendationId}
  • /ads/fbads/campaign/interest/suggestions
  • /ads/fbads/campaign/language/suggestions
  • /ads/fbads/campaign/location/suggestions
  • /ads/fbads/get/video/thumbnail
  • /ads/gads/campaign/location/suggestions
  • /ads/fbads/campaign/location/suggestions/default
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • POST
  • DELETE PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
ConnectionsService
  • /connections/{provider}
  • DELETE
CouponPartnerApiService
  • /partner/stackCoupon
  • PUT
CustomizeReportService
  • /stats/report/deletepicture
  • /stats/report/deletetemplate
  • /stats/report/reporttemplateName
  • /stats/report/reporttemplateparam
  • /stats/report/savetemplate
  • /stats/report/updatereportlogo
  • /stats/report/template/default-resources
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
DataStudioService
  • /datastudio/fbads/ads
  • /datastudio/tiktokads/ads
  • GET
  • GET
InstagramWHService
  • /instagramwebhook
  • GET POST
OfflineReportService
  • /report/list
  • GET
PingService
  • /mtr/ping
  • GET
PlannerService
  • /actions/deleteProgrammedTW
  • /actions/deleteSelectedDevices
  • /actions/historyTW
  • /actions/igSettings
  • /actions/program
  • /actions/programmedTW
  • /actions/reloadDevices
  • /actions/selectedDevices
  • /actions/setTimeZone
  • /actions/csv/table
  • /actions/facebook/suggestions
  • /actions/instagram/suggestions
  • /actions/linkedin/suggestions
  • /actions/pinterest/boards
  • /actions/tweet/schedule
  • /actions/twitter/suggestions
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
ProfileSettingsService
  • /profile/lastsyncs
  • /profile/subscription
  • /profile/report/sections
  • GET
  • GET
  • GET
StatsService
  • /stats/adgroups
  • /stats/ads
  • /stats/posts
  • /stats/adwords/campaigns
  • /stats/adwords/keywords
  • /stats/age/{provider}
  • /stats/aggregation/{metric}
  • /stats/aggregations/{category}
  • /stats/besttimes/{type}
  • /stats/city/{provider}
  • /stats/conversations/{provider}
  • /stats/country/{provider}
  • /stats/deletecomment/{provider}
  • /stats/distribution/{type}
  • /stats/facebook/getcurrency
  • /stats/facebook/getvalue
  • /stats/facebook/modifyboost
  • /stats/facebook/posts
  • /stats/facebookads/campaigns
  • /stats/facebookads/metricvalue
  • /stats/fbgroup/posts
  • /stats/gender/{provider}
  • /stats/gmb/review
  • /stats/gmb/reviewbyid
  • /stats/influencers/add
  • /stats/influencers/cost
  • /stats/influencers/refresh
  • /stats/influencers/remove
  • /stats/influencers/{provider}
  • /stats/instagram/addcatalogButton
  • /stats/instagram/addcatalogitem
  • /stats/instagram/deletecatalogitem
  • /stats/instagram/editcatalogbutton
  • /stats/instagram/editcatalogitem
  • /stats/instagram/editcoloritem
  • /stats/instagram/getbioButtons
  • /stats/instagram/getbiocatalog
  • /stats/instagram/hashtags
  • /stats/instagram/posts
  • /stats/instagram/recentmedia
  • /stats/instagram/stories
  • /stats/instagram/updateButtonPosition
  • /stats/linkedin/posts
  • /stats/pinterest/boards
  • /stats/postlike/{provider}
  • /stats/postmessage/{provider}
  • /stats/rt/pvperhour
  • /stats/rt/sessions
  • /stats/rt/twitterProfile
  • /stats/rt/values
  • /stats/tiktokads/campaigns
  • /stats/timeline/{metric}
  • /stats/trafficsource/{provider}
  • /stats/twEvents/{type}
  • /stats/twitch/clips
  • /stats/twitch/subscriptions
  • /stats/twitch/videos
  • /stats/twitter/follow
  • /stats/twitter/posts
  • /stats/twitter/unfollow
  • /stats/values/{category}
  • /stats/youtube/videos
  • /stats/facebook/boost/{postId}
  • /stats/facebook/posts/competitor
  • /stats/facebookads/adgroups/customeventtype
  • /stats/facebookads/campaigns/favourite-conversion
  • /stats/gmb/media/{type}
  • /stats/gmb/review/reply
  • /stats/instagram/posts/competitor
  • /stats/link/distribution/{type}
  • /stats/rt/distribution/{type}
  • /stats/twitch/subscriptions/doughnut
  • /stats/twitch/video/clips
  • /stats/twitter/posts/competitor
  • /stats/twitter/posts/types
  • /stats/facebook/boost/pending/{postId}
  • /stats/gmb/review/reply/remove
  • /stats/rt/twitter/tweets/{type}
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
UserSettingsService
  • /user/groot
  • /user/settings
  • /user/unlock
  • GET
  • GET
  • POST
VendastaRestService
  • /mktp/purchase
  • /mktp/session
  • GET POST
  • POST

Data Types

JSON

type description
Ad
AdCampaign
AdRecommendation
AdRecommendationType
AdSet
AdsKeyword
AdsLocationLocale
CalendarCSVRow
CouponResult
DataStudioAd
FacebookAdsCustomEvent
FacebookAdsInterest
FacebookGroup
FacebookPost
FbAdAccount
GmbReview
GoogleAdsForecast
GoogleAdsInterest
Influencer
InfluencersRestrictions
InstagramAccount
InstagramHashtag
InstagramPost
InstagramStory
JOB_STATUS
Link
LinkedinCompany
LinkedinPost
Message
Payment
PinterestBoard
ProfileCollaborator
ProgrammedTweet
PublicBlog
PublicPost
ReportHistoryItem
SessionToken
Subscription
SubscriptionPlan
Tag
TemplateReport
Tweet https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/tweet-object
TwitchVideo
TwitterEvent
TwitterFollowersInfo
TwitterProfile
UserDevice
UserSettings
UserSettingsReportSections
UserStatus
VisitorEvent
VisitorSession
VisitorSessionList
WhiteLabelSettings
YouTubeGlobalVideo

XML

Default Namespace (schema)
type description
dataStudioAd