API documentation
Introduction
The quintly API is made for you to access all data points you already know from our tool. You need to have a quintly business account in order to access this API. Please get in touch with us if you like to get access.
Authentication
For authentication we use Basic Auth via HTTPS. For the username you have to send your quintly client id and for the password your API secret. If you don't have these details yet, please get in touch with our support.
Fetching data
The are two ways of fetching data. Either by asking for one of our predefined metrics, or by specifying a completely customized query by using QQL (Quintly Query Language).
For both ways you need to specify the following mandatory parameters:
- startTime: The beginning of the period you want to get the data for in format YYYY-MM-DD (interpreted in the timezone set within your account)
- endTime: The end of the period you want to get the data for in format YYYY-MM-DD (interpreted in the timezone set within your account)
- interval: The aggregation interval of the analysis (daily, weekly, monthly, yearly, total)
- profileIds: A comma-separated list of profile ids (you can find the id of a profile within our tool). You can only fetch data for profiles added to your quintly account.
In addition to this, you have to set the metric parameter to fetch a predefined metric (see the list of predefined metrics here) or the qqlQuery parameter to fetch data for a customized query written in QQL. At least one of those parameter has to be set.
Example requests
Fetching the predefined fanCount metric (total fan numbers)
Fetching data by using a custom query written in QQL to get the total fan numbers
Response format
The response will be sent in JSON format. Here is a sample response for the second example above:
If something goes wrong, errors will always be returned in the following structure:
Predefined metrics
- (Playback Locations)
- averageCommentsPerOwnPost (Average Comments Per Post)
- averageInteractionsPerOwnPost (Average Interactions Per Post)
- averageLikesPerOwnPost (Average Likes Per Post)
- averageSharesPerOwnPost (Average Shares Per Post)
- checkins (Check Ins)
- checkinsChange (Check Ins Change)
- fanChange (Fans Change)
- fanChangePerDay (Fans Change Per Weekday)
- fanChangeRate (Fans Change Rate)
- fanCount (Fans Total)
- fanDevelopmentTable (Fans Table)
- fanDistribution (Fan Distribution)
- fanDistributionDevelopment (Fan Distribution Development)
- fansByCountryMap (Fans By Country World Map)
- fansByCountryTable (Fans By Country Table)
- feedAlexaPageViews (Alexa Page Views Per Million)
- feedAlexaPageViewsChange (Alexa Page Views Per Million Change)
- feedAlexaPageViewsPerUser (Alexa Page Views Per User)
- feedAlexaRank (Alexa Rank)
- feedAlexaRankChange (Alexa Rank Change)
- feedAlexaReach (Alexa Reach Per Million)
- feedAlexaReachChange (Alexa Reach Per Million Change)
- feedAlexaSitesLinkingIn (Alexa Sites Linking In)
- feedAlexaSitesLinkingInChange (Alexa Sites Linking In Change)
- feedAverageFacebookInteractionsPerPost (Average Facebook Interactions Per Post)
- feedKeyMetricsRadar (Key Metrics Radar)
- feedKeyMetricsTable (Key Metrics Table)
- feedPosts (Posts)
- feedPostsTable (Posts Table)
- googlePlusAverageCommentsPerPost (Average Comments Per Post)
- googlePlusAverageInteractionsPerPost (Average Interactions Per Post)
- googlePlusAveragePlusOnePerPost (Average +1's Per Post)
- googlePlusAverageSharesPerPost (Average Shares Per Post)
- googlePlusCircleFollower (Circle Followers Total)
- googlePlusCircleFollowerChange (Circle Followers Change)
- googlePlusCircleFollowerChangeRate (Circle Followers Change Rate)
- googlePlusInteractionRate (Interaction Rate)
- googlePlusInteractionRateByHour (Interaction Rate By Hour)
- googlePlusInteractionRateByPostType (Interaction Rate By Post Type)
- googlePlusInteractionRateByWeekday (Interaction Rate By Weekday)
- googlePlusInteractionRateByWeekdayAndHour (Interaction Rate By Time)
- googlePlusInteractionsDistribution (Interactions Distribution)
- googlePlusKeyMetricsRadar (Key Metrics Radar)
- googlePlusKeyMetricsTable (Key Metrics Table)
- googlePlusPagePlusOne (Page +1's Total)
- googlePlusPagePlusOneChange (Page +1's Change)
- googlePlusPagePlusOneChangeRate (Page +1's Change Rate)
- googlePlusPosts (Posts)
- googlePlusPostsAndInteractionRateByWeekdayAndHour (Posts/Interactions Comparison)
- googlePlusPostsByHour (Posts By Hour)
- googlePlusPostsByWeekday (Posts By Weekday)
- googlePlusPostsByWeekdayAndHour (Posts By Time)
- googlePlusPostsTable (Posts Table)
- googlePlusPostTypeDistribution (Post Type Distribution)
- insightsOwnPostsTable (Own Posts Table)
- insightsPageEngagedUsers (Engaged Users)
- insightsPageFans (Fans Total)
- insightsPageFansUnlikes (Page Unlikes)
- insightsPageImpressions (Reach)
- insightsPageNegativeFeedbackDayHideAllClicks (Hide All Clicks)
- insightsPageNegativeFeedbackDayHideClicks (Hide Clicks)
- insightsPageNegativeFeedbackDayReportSpamClicks (Spam Report Clicks)
- insightsPageNegativeFeedbackDayUnlikePageClicks (Page Unlike Clicks)
- insightsPageViews (Views)
- instagramAverageCommentsPerPost (Average Comments Per Post)
- instagramAverageInteractionsPerPost (Average Interactions Per Post)
- instagramAverageLikesPerPost (Average Likes Per Post)
- instagramFollower (Followers Total)
- instagramFollowerChange (Followers Change)
- instagramFollowerChangeRate (Followers Change Rate)
- instagramFollowing (Following Total)
- instagramFollowingChange (Following Change)
- instagramFollowingChangeRate (Following Change Rate)
- instagramImageFilterDistribution (Image Filter Distribution)
- instagramInteractionRate (Interaction Rate)
- instagramInteractionRateByHour (Interaction Rate By Hour)
- instagramInteractionRateByPostType (Interaction Rate By Post Type)
- instagramInteractionRateByWeekday (Interaction Rate By Weekday)
- instagramInteractionRateByWeekdayAndHour (Interaction Rate By Time)
- instagramInteractionsDistribution (Interactions Distribution)
- instagramKeyMetricsRadar (Key Metrics Radar)
- instagramKeyMetricsTable (Key Metrics Table)
- instagramPosts (Posts)
- instagramPostsAndInteractionRateByWeekdayAndHour (Posts/Interactions Comparison)
- instagramPostsByHour (Posts By Hour)
- instagramPostsByWeekday (Posts By Weekday)
- instagramPostsByWeekdayAndHour (Posts By Time)
- instagramPostsTable (Posts Table)
- instagramPostsTypeDistribution (Posts Type Distribution)
- instagramVideoFilterDistribution (Video Filter Distribution)
- interactionRate (Interaction Rate)
- interactionRateByHour (Interaction Rate By Hour)
- interactionRateByPostType (Interaction Rate By Post Type)
- interactionRateByWeekday (Interaction Rate By Weekday)
- interactionRateByWeekdayAndHour (Interaction Rate By Time)
- interactionsDistribution (Interactions Distribution)
- keyInfluencersUsersTable (Key Influencers)
- keyMetricsRadar (Key Metrics Radar)
- keyMetricsTable (Key Metrics Table)
- linkedInAverageCommentsPerUpdate (Average Comments Per Update)
- linkedInAverageInteractionsPerUpdate (Average Interactions Per Update)
- linkedInAverageLikesPerUpdate (Average Likes Per Update)
- linkedInCompanyFollower (Followers Total)
- linkedInCompanyFollowerChange (Followers Change)
- linkedInCompanyFollowerChangeRate (Followers Change Rate)
- linkedInInteractionRate (Interaction Rate)
- linkedInInteractionRateByHour (Interaction Rate By Hour)
- linkedInInteractionRateByUpdateType (Interaction Rate By Update Type)
- linkedInInteractionRateByWeekday (Interaction Rate By Weekday)
- linkedInInteractionRateByWeekdayAndHour (Interaction Rate By Time)
- linkedInInteractionsDistribution (InteractionsDistribution)
- linkedInJobUpdates (Job Updates)
- linkedInJobUpdatesTable (Job Updates Table)
- linkedInKeyMetricsRadar (Key Metrics Radar)
- linkedInKeyMetricsTable (Key Metrics Table)
- linkedInUpdates (Updates)
- linkedInUpdatesAndInteractionRateByWeekdayAndHour (Updates/Interactions Comparison)
- linkedInUpdatesByHour (Updates By Hour)
- linkedInUpdatesByWeekday (Updates By Weekday)
- linkedInUpdatesByWeekdayAndHour (Updates By Time)
- linkedInUpdatesTable (Updates Table)
- linkedInUpdatesTypeDistribution (Updates Type Distribution)
- overallAudience (Overall Audience)
- overallAudienceChange (Overall Audience Change)
- overallAudienceChangeRate (Overall Audience Change Rate)
- overallAudienceDistributionDevelopment (Overall Audience Distribution Development)
- overallContent (Overall Posted Content)
- overallInteractionRate (Overall Interaction Rate)
- ownPosts (Own Posts)
- ownPostsAndInteractionRateByWeekdayAndHour (Posts/Interactions Comparison)
- ownPostsAppUsage (Own Posts App Usage)
- ownPostsByHour (Own Posts By Hour)
- ownPostsByWeekday (Own Posts By Weekday)
- ownPostsByWeekdayAndHour (Own Posts By Time)
- ownPostsTable (Own Posts Table)
- peopleTalking (People Talking About This)
- peopleTalkingAverage (Average People Talking About This)
- peopleTalkingRate (People Talking About This Rate)
- peopleTalkingRateAverage (Average People Talking About This Rate)
- postTypeDistribution (Post Type Distribution)
- questionsTable (Questions Table)
- realtimeFanChange (Realtime Fans Change)
- realtimeFanCount (Realtime Fans Total)
- responseTimes (Response Times)
- responseTimesDistribution (Response Times Distribution)
- twitterAverageFavoritesPerOwnTweet (Average Favorites Per Own Tweet)
- twitterAverageRetweetsPerOwnTweet (Average Retweets Per Own Tweet)
- twitterFollower (Followers Total)
- twitterFollowerChange (Followers Change)
- twitterFollowerChangeRate (Followers Change Rate)
- twitterFollowing (Following Total)
- twitterFollowingChange (Following Change)
- twitterFollowingChangeRate (Following Change Rate)
- twitterInteractionRate (Interaction Rate)
- twitterKeyInfluencersTable (Key Influencers)
- twitterKeyMetricsRadar (Key Metrics Radar)
- twitterKeyMetricsTable (Key Metrics Table)
- twitterMentions (Mentions)
- twitterMentionsTable (Mentions Table)
- twitterOwnTweetsChange (Own Tweets)
- twitterOwnTweetsTable (Own and Retweeted Tweets Table)
- twitterQuestionsTable (Questions Table)
- twitterRepliesToUsersChange (Replies To Users)
- twitterResponseTimes (Response Times)
- twitterResponseTimesDistribution (Response Times Distribution)
- twitterRetweetedTweetsChange (Retweeted Tweets)
- twitterRetweets (Retweets)
- twitterTweets (Tweets Total)
- twitterTweetsChange (Tweets Change)
- userPosts (User Posts)
- userPostsAppUsage (User Posts App Usage)
- userPostsByHour (User Posts By Hour)
- userPostsByWeekday (User Posts By Weekday)
- userPostsByWeekdayAndHour (User Posts By Time)
- userPostsTable (User Posts Table)
- youtubeAverageCommentsPerVideo (Average Comments Per Video)
- youtubeAverageDislikesPerVideo (Average Dislikes Per Video)
- youtubeAverageFavoritesPerVideo (Average Favorites Per Video)
- youtubeAverageInteractionsPerVideo (Average Interactions Per Video)
- youtubeAverageLikesPerVideo (Average Likes Per Video)
- youtubeAverageViewsPerVideo (Average Views Per Video)
- youtubeInteractionRate (Interaction Rate)
- youtubeKeyMetricsRadar (Key Metrics Radar)
- youtubeKeyMetricsTable (Key Metrics Table)
- youtubeSubscriber (Subscribers Total)
- youtubeSubscriberChange (Subscribers Change)
- youtubeSubscriberChangeRate (Subscribers Change Rate)
- youtubeVideos (Videos Change)
- youtubeVideosTable (Videos Table)
- youtubeVideosTotal (Videos Total)
- youtubeViewsChange (Views Change)
- youtubeViewsChangeRate (Views Change Rate)
- youtubeViewsTotal (Views Total)
- youtubeViewSubscriberRate (Views Subscriber Rate)
Rate limits
So far rate limits have been set very loose and you should not hit any limits at all.