Agorapulse Report API
The Report API from Agorapulse — 3 operation(s) for report.
OpenAPI Specification
openapi: 3.1.0
info:
title: Open Calendar Notes Report API
description: Agorapulse's Open API documentation
version: '1.0'
security:
- bearerAuth: []
tags:
- name: Report
paths:
/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/audience:
get:
tags:
- Report
summary: Get audience report
description: Get audience report
operationId: getAudience
parameters:
- name: organizationId
in: path
description: Organization id
required: true
schema:
type: string
- name: workspaceId
in: path
description: Workspace id
required: true
schema:
type: string
- name: profileUid
in: path
description: Profile uid
required: true
schema:
type: string
- name: since
in: query
required: true
explode: false
schema:
type: string
- name: until
in: query
required: true
explode: false
schema:
type: string
responses:
'200':
description: Audience is returned
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAudienceInsight'
/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/communitymanagement:
get:
tags:
- Report
summary: Get community management report
description: Get community management report
operationId: getCommunityManagement
parameters:
- name: organizationId
in: path
description: Organization id
required: true
schema:
type: string
- name: workspaceId
in: path
description: Workspace id
required: true
schema:
type: string
- name: profileUid
in: path
description: Profile uid
required: true
schema:
type: string
- name: since
in: query
required: true
explode: false
schema:
type: string
- name: until
in: query
required: true
explode: false
schema:
type: string
responses:
'200':
description: Community management is returned
content:
application/json:
schema:
$ref: '#/components/schemas/CommunityManagementInsight'
/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/content:
get:
tags:
- Report
summary: Get content report
description: Get content report
operationId: getContentReport
parameters:
- name: organizationId
in: path
description: Organization id
required: true
schema:
type: string
- name: workspaceId
in: path
description: Workspace id
required: true
schema:
type: string
- name: profileUid
in: path
description: Profile uid
required: true
schema:
type: string
- name: since
in: query
required: true
explode: false
schema:
type: string
- name: until
in: query
required: true
explode: false
schema:
type: string
responses:
'200':
description: Content report is returned
content:
application/json:
schema:
$ref: '#/components/schemas/ContentReportInsight_1'
components:
schemas:
ContentReportInsight_1:
required:
- data
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ContentReportData'
description: List of content report insight
TikTokContentReportInsight:
type: object
properties:
completionRate:
type: integer
description: Average viewing time relative to total video duration
format: int64
example: null
commentCount:
type: integer
description: Number of comments
format: int64
example: 583
engagementRatePerView:
type: number
description: Ratio of engagement to view as a percentage
format: double
example: 78.3
engagementRatePerReach:
type: number
description: Ratio of engagement to reach as a percentage
format: double
example: 67.5
viewsCount:
type: integer
description: Number of views
format: int64
example: 928
likeCount:
type: integer
description: Number of likes
format: int64
example: 583
reachCount:
type: integer
description: Number of reach
format: int64
example: 583
shareCount:
type: integer
description: Number of shares
format: int64
example: 583
videoCompletedCount:
type: integer
description: Number of times the video is watched fully
format: int64
example: 76
videoReplaysCount:
type: integer
description: Number of video replays
format: int64
example: 45
videoViewsTimeWatchedCount:
type: integer
description: Total viewing time in seconds
format: int64
example: 12
videoViewersRateByGender:
type: object
additionalProperties:
type: number
format: double
description: Video viewers rate by gender
example:
Female: 0.457
Male: 0.403
Other: 0.14
videoViewersRateByCountry:
type: object
additionalProperties:
type: number
format: double
description: Video viewers rate by country
example:
CA: 0.0132
GB: 0.7303
US: 0.2565
videoViewersRateByCity:
type: object
additionalProperties:
type: number
format: double
description: Video viewers rate by city
example:
US Cincinnati: 0.597
US Los Angeles: 0.403
description: TikTok Specific Content Report Insights
allOf:
- $ref: '#/components/schemas/ContentReportData'
InstagramStoryContentReportInsight:
type: object
properties:
reachCount:
type: integer
description: Number of reach
format: int64
example: 283
engagementRatePerImpression:
type: number
description: Ratio of engagement to impression as a percentage
format: double
example: 46.7
engagementRatePerReach:
type: number
description: Ratio of engagement to reach as a percentage
format: double
example: 50
impressionsCount:
type: integer
description: Number of impressions
format: int64
example: 342
swipeForwardCount:
type: integer
description: Number of swipes forward
format: int64
example: 23
tapBackCount:
type: integer
description: Number of taps back
format: int64
example: 12
tapForwardCount:
type: integer
description: Number of taps forward
format: int64
example: 0
exitCount:
type: integer
description: Number of taps exit
format: int64
example: 0
type:
type: string
description: Type of post
example: story
description: Instagram Stories Specific Content Report Insights
allOf:
- $ref: '#/components/schemas/ContentReportData'
LinkedinContentReportInsight:
type: object
properties:
clicksCount:
type: integer
description: Number of clicks
format: int64
example: 573
organicClicksCount:
type: integer
description: Number of organic clicks
format: int64
example: 173
paidClicksCount:
type: integer
description: Number of paid clicks
format: int64
example: 400
commentsCount:
type: integer
description: Number of comments
format: int64
example: 23
organicCommentsCount:
type: integer
description: Number of organic comments
format: int64
example: 5
paidCommentsCount:
type: integer
description: Number of paid comments
format: int64
example: 18
organicEngagementCount:
type: integer
description: Number of organic engagement
format: int64
example: 220
paidEngagementCount:
type: integer
description: Number of paid engagement
format: int64
example: 557
engagementRatePerImpression:
type: number
description: Ratio of engagement to impression as a percentage
format: double
example: 68.8
organicEngagementRatePerImpression:
type: number
description: Ratio of organic engagement to impression as a percentage
format: double
example: 21.2
paidEngagementRatePerImpression:
type: number
description: Ratio of paid engagement to impression as a percentage
format: double
example: 47.6
engagementRatePerReach:
type: number
description: Ratio of engagement to reach as a percentage
format: double
example: 65.2
organicEngagementRatePerReach:
type: number
description: Ratio of organic engagement to reach as a percentage
format: double
example: 17.5
paidEngagementRatePerReach:
type: number
description: Ratio of paid engagement to reach as a percentage
format: double
example: 47.7
impressionsCount:
type: integer
description: Number of impressions
format: int64
example: 756
organicImpressionsCount:
type: integer
description: Number of organic impressions
format: int64
example: 276
paidImpressionsCount:
type: integer
description: Number of paid impressions
format: int64
example: 480
likesCount:
type: integer
description: Number of likes
format: int64
example: 215
organicLikesCount:
type: integer
description: Number of organic likes
format: int64
example: 69
paidLikesCount:
type: integer
description: Number of paid likes
format: int64
example: 146
reachCount:
type: integer
description: Number of reach
format: int64
example: 1200
organicReachCount:
type: integer
description: Number of organic reach
format: int64
example: 350
paidReachCount:
type: integer
description: Number of paid reach
format: int64
example: 850
sharesCount:
type: integer
description: Number of shares
format: int64
example: 21
organicSharesCount:
type: integer
description: Number of organic shares
format: int64
example: 3
paidSharesCount:
type: integer
description: Number of paid shares
format: int64
example: 18
videoViewsCount:
type: integer
description: Number of video views
format: int64
example: 86
videoViewsTimeWatchedCount:
type: integer
description: The time the video was watched in milliseconds
format: int64
example: 86
videoViewersCount:
type: integer
description: Number of viewers who made engaged plays on the video
format: int64
example: 86
video3sViewsTimeWatchedCount:
type: integer
description: The time watched in milliseconds for video play-pause cycles that are at least 3 seconds
format: int64
example: 86
organicVideoViewsCount:
type: integer
description: Number of organic video views
format: int64
example: 14
paidVideoViewsCount:
type: integer
description: Number of paid video views
format: int64
example: 72
description: Linkedin Specific Content Report Insights
allOf:
- $ref: '#/components/schemas/ContentReportData'
FacebookCommunityManagementAction:
type: object
allOf:
- $ref: '#/components/schemas/CommunityManagementAction'
- type: object
properties:
removedCount:
type: integer
description: Number of items removed
format: int64
example: 5
TwitterContentReportInsight:
type: object
properties:
commentsCount:
type: integer
description: Number of comments
format: int64
example: 21
engagementRatePerImpression:
type: number
description: Ratio of engagement to impression as a percentage
format: double
example: 65.4
impressionsCount:
type: integer
description: Number of impressions
format: int64
example: 277
likesCount:
type: integer
description: Number of likes
format: int64
example: 65
quotePostsCount:
type: integer
description: Number of reposts
format: int64
example: 45
repostsCount:
type: integer
description: Number of reposts
format: int64
example: 23
videoViewsCount:
type: integer
description: Number of video views
format: int64
example: 73
description: Twitter Specific Content Report Insights
allOf:
- $ref: '#/components/schemas/ContentReportData'
CommunityManagementInsight:
required:
- data
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CommunityManagementByDate'
description: List of community management insight
YoutubeContentReportInsight:
type: object
properties:
addedToPlaylistCount:
type: integer
description: Number of times this video was added to a playlist
format: int64
example: 830
commentsCount:
type: integer
description: Number of comments
format: int64
example: 2
dislikeCount:
type: integer
description: Number of dislikes
format: int64
example: 15
subscribersGainCount:
type: integer
description: Number of subscribers gained from the video
format: int64
example: 10
subscribersLostCount:
type: integer
description: Number of subscribers lost from the video
format: int64
example: 2
likesCount:
type: integer
description: Number of likes
format: int64
example: 65
removedFromPlaylistCount:
type: integer
description: Number of times this video was removed to a playlist
format: int64
example: 400
sharesCount:
type: integer
description: Number of shares
format: int64
example: 46
videoViewsCount:
type: integer
description: Number of video views
format: int64
example: 23
videoViewsTimeWatchedRate:
type: number
description: Ratio of average viewing time to total video duration as a percentage
format: double
example: 75.8
description: Youtube Specific Content Report Insights
allOf:
- $ref: '#/components/schemas/ContentReportData'
YoutubeAudienceInsight:
type: object
properties:
addedToPlaylistCount:
type: integer
description: Number of times videos of the channel were added to a playlist
format: int64
example: 300
dislikesCount:
type: integer
description: Number of dislikes
format: int64
example: 30
estimatedWatchedTimeCount:
type: integer
description: Time people spent watching videos from your channel in minutes
format: int64
example: 10
likesCount:
type: integer
description: Number of likes
format: int64
example: 12
publishedVideoCount:
type: integer
description: Number of published videos
format: int64
example: 1
removedFromPlaylistCount:
type: integer
description: Number of times videos of the channel were removed from a playlist
format: int64
example: 3
subscribersCount:
type: integer
description: Number of total subscribers
format: int64
example: 199
subscribersLostCount:
type: integer
description: Number of subscribers lost
format: int64
example: 9
subscribersGainedCount:
type: integer
description: Number of subscribers gained
format: int64
example: 9
subscribersNetGrowth:
type: integer
description: Net subscriber growth (gained minus lost)
format: int64
example: 0
videoViewsCount:
type: integer
description: Number of times your videos has been viewed
format: int64
example: 90
receivedCommentsCount:
type: integer
description: Number of received comments
format: int64
example: 6
sharesCount:
type: integer
description: Number of shares
format: int64
example: 23
positiveItemsCount:
type: integer
description: Number of items with positive sentiment
format: int64
example: 24
neutralItemsCount:
type: integer
description: Number of items with neutral sentiment
format: int64
example: 2
negativeItemsCount:
type: integer
description: Number of items with negative sentiment
format: int64
example: 12
sentimentScore:
type: number
description: Ratio of positive items divided by the total of positive and negative items
format: double
example: 50
description: Youtube Specific Audience Insights
allOf:
- $ref: '#/components/schemas/AudienceReportByDate'
YoutubeCommunityManagementAction:
type: object
allOf:
- $ref: '#/components/schemas/CommunityManagementAction'
- type: object
properties:
removedCount:
type: integer
description: Number of items removed
format: int64
example: 5
InstagramCommunityManagementAction:
type: object
allOf:
- $ref: '#/components/schemas/CommunityManagementAction'
- type: object
properties:
removedCount:
type: integer
description: Number of items removed
format: int64
example: 5
LinkedinAudienceInsight:
type: object
properties:
clicksCount:
type: integer
description: Number of clicks on posts
format: int64
example: 2
organicClicksCount:
type: integer
description: Number of organic clicks on posts
format: int64
example: 0
paidClicksCount:
type: integer
description: Number of paid clicks on posts
format: int64
example: 2
receivedCommentsCount:
type: integer
description: Number of received comments
format: int64
example: 6
organicReceivedCommentsCount:
type: integer
description: Number of organic comments received on posts
format: int64
example: 1
paidReceivedCommentsCount:
type: integer
description: Number of paid comments received on posts
format: int64
example: 5
organicEngagementCount:
type: integer
description: Number of organic engagement
format: int64
example: 33
paidEngagementCount:
type: integer
description: Number of paid engagement
format: int64
example: 66
engagementRatePerImpression:
type: number
description: Ratio of engagement to impression as a percentage
format: double
example: 24.2
organicEngagementRatePerImpression:
type: number
description: Ratio of organic engagement to impression as a percentage
format: double
example: 10.2
paidEngagementRatePerImpression:
type: number
description: Ratio of paid engagement to impression as a percentage
format: double
example: 14
engagementRatePerReach:
type: number
description: Ratio of engagement to reach as a percentage
format: double
example: 34.8
organicEngagementRatePerReach:
type: number
description: Ratio of organic engagement to reach as a percentage
format: double
example: 14.4
paidEngagementRatePerReach:
type: number
description: Ratio of paid engagement to reach as a percentage
format: double
example: 20.4
followersCount:
type: integer
description: Number of total followers
format: int64
example: 199
followersGainedCount:
type: integer
description: Number of followers gained
format: int64
example: 9
deprecated: true
followersNetGrowth:
type: integer
description: Net follower growth (gained minus lost)
format: int64
example: 9
impressionsCount:
type: integer
description: Number of impressions
format: int64
example: 245
organicImpressionsCount:
type: integer
description: Number of organic impressions
format: int64
example: 90
paidImpressionsCount:
type: integer
description: Number of paid impressions
format: int64
example: 155
likesCount:
type: integer
description: Number of likes
format: int64
example: 449
organicLikesCount:
type: integer
description: Number of organic likes on posts
format: int64
example: 58
paidLikesCount:
type: integer
description: Number of paid likes on posts
format: int64
example: 391
organicFollowersGainedCount:
type: integer
description: Number of organic followers gained
format: int64
example: 24
deprecated: true
paidFollowersGainedCount:
type: integer
description: Number of paid followers gained
format: int64
example: 54
deprecated: true
organicFollowersNetGrowth:
type: integer
description: Net organic follower growth (gained minus lost)
format: int64
example: 24
paidFollowersNetGrowth:
type: integer
description: Net paid follower growth (gained minus lost)
format: int64
example: 54
publishedPostsCount:
type: integer
description: Number of posts published
format: int64
example: 9
reachCount:
type: integer
description: Number of reach
format: int64
example: 192
organicReachCount:
type: integer
description: Number of organic reach
format: int64
example: 43
paidReachCount:
type: integer
description: Number of paid reach
format: int64
example: 149
removedCount:
type: integer
description: Number of removed items
format: int64
example: 1
positiveItemsCount:
type: integer
description: Number of items with positive sentiment
format: int64
example: 24
neutralItemsCount:
type: integer
description: Number of items with neutral sentiment
format: int64
example: 2
negativeItemsCount:
type: integer
description: Number of items with negative sentiment
format: int64
example: 12
sentimentScore:
type: number
description: Ratio of positive items divided by the total of positive and negative items
format: double
example: 50
sharesCount:
type: integer
description: Number of shares
format: int64
example: 23
organicSharesCount:
type: integer
description: Number of organic shares
format: int64
example: 3
paidSharesCount:
type: integer
description: Number of paid shares
format: int64
example: 20
description: Linkedin Specific Audience Insights
allOf:
- $ref: '#/components/schemas/AudienceReportByDate'
FacebookAudienceInsight:
type: object
properties:
angryCount:
type: integer
description: Number of angry (reaction)
format: int64
example: 120
organicEngagementCount:
type: integer
description: Number of organic engagement
format: int64
example: 23
paidEngagementCount:
type: integer
description: Number of paid engagement
format: int64
example: 76
engagementRatePerView:
type: number
description: Ratio of engagement to view as a percentage
format: double
example: 24.2
organicEngagementRatePerView:
type: number
description: Ratio of organic engagement to view as a percentage
format: double
example: 10.2
paidEngagementRatePerView:
type: number
description: Ratio of paid engagement to view as a percentage
format: double
example: 14
engagementRatePerReach:
type: number
description: Ratio of engagement to reach as a percentage
format: double
example: 26.6
organicEngagementRatePerReach:
type: number
description: Ratio of organic engagement to reach as a percentage
format: double
example: 14.4
paidEngagementRatePerReach:
type: number
description: Ratio of paid engagement to reach as a percentage
format: double
example: 20.4
followersGainedCount:
type: integer
description: Number of gained followers
format: int64
example: 25
followersLostCount:
type: integer
description: Number of lost followers
format: int64
example: 2
followersNetGrowth:
type: integer
description: Net follower growth (gained minus lost)
format: int64
example: 23
followersCount:
type: integer
description: Number of total followers
format: int64
example: 3765
viewsCount:
type: integer
description: Number of views
format: int64
example: 245
organicViewsCount:
type: integer
description: Number of organic views
format: int64
example: 45
paidViewsCount:
type: integer
description: Number of paid views
format: int64
example: 200
hahaCount:
type: integer
description: Number of haha (reaction)
format: int64
example: 830
loveCount:
type: integer
description: Number of love (reaction)
format: int64
example: 830
receivedMessagesCount:
type: integer
description: Number of received messages
format: int64
example: 3
publishedLinksCount:
type: integer
description: Number of published links
format: int64
example: 12
publishedPhotosCount:
type: integer
description: Number of published photos
format: int64
example: 23
publishedStatusCount:
type: integer
description: Number of published status
format: int64
example: 3
publishedVideoCount:
type: integer
description: Number of published videos
format: int64
example: 2
reactionsCount:
type: integer
description: Number of reactions
format: int64
example: 99
receivedCommentsCount:
type: integer
description: Number of received comments
format: int64
example: 6
organicReceivedCommentsCount:
type: integer
description: Number of organic received comments
format: int64
example: 2
paidReceivedCommentsCount:
type: integer
description: Number of paid received comments
format: int64
example: 4
sharesCount:
type: integer
description: Number of shares
format: int64
example: 23
organicSharesCount:
type: integer
description: Number of organic shares
format: int64
example: 3
paidSharesCount:
type: integer
description: Number of paid shares
format: int64
example: 20
videoViewsAutoplayCount:
type: integer
description: Number of video views generated by autoplayed videos
format: int64
example: 56
videoViewsClickCount:
type: integer
description: Number of video views generated by click-to-play
format: int64
example: 54
positiveItemsCount:
type: integer
description: Number of items with positive sentiment
format: int64
example: 24
neutralItemsCount:
type: integer
description: Number of items with neutral sentiment
format: int64
example: 2
negativeItemsCount:
type: integer
description: Number of items with negative sentiment
format: int64
example: 12
sadCount:
type: integer
description: Number of sad (reaction)
format: int64
example: 1200
sentimentScore:
type: number
description: Ratio of positive items divided by the total of positive and negative items
format: double
example: 50
videoViewsCount:
type: integer
description: Number of video views
format: int64
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agorapulse/refs/heads/main/openapi/agorapulse-report-api-openapi.yml