Share via

Member Video Statistics

Warning

Deprecation Notice The Marketing Version 202411 (Marketing November 2024) has been sunset. We recommend that you migrate to the latest versioned APIs to avoid disruptions. See the Migration page for more details. If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.

Try in Postman

The memberCreatorVideoAnalytics API retrieves video analytics from the member posts for an authenticated member.

Permissions

Permission Description
r_member_postAnalytics Retrieve your posts and their reporting data.

Metrics Definition for Member Post Analytics

Metric Definition
VIDEO_PLAY Video plays count with play-pause cycles for at least 2 seconds. Auto-looping videos are counted as one when loaded. Each subsequent auto-looped play doesn't increase this metric. Analytics data for this metric won't be available after one year of post creation.
VIDEO_VIEWER Unique viewers who made engaged plays on the video. Auto-looping videos are counted as one when loaded. Each subsequent auto-looped play doesn't increase this metric. Analytics data for this metric won't be available after one year of post creation.
VIDEO_WATCH_TIME The total time the video was watched, in milliseconds. Video auto-looping will continue to increase this metric for each subsequent play.

Note

The VIDEO_PLAY, VIDEO_VIEWER, and VIDEO_WATCH_TIME metrics are only available for posts that contain a video. If the post doesn't contain a video, these metrics won't be returned. The VIDEO_VIEWER and VIDEO_WATCH_TIME metrics don't support daily aggregation or time-bound queries.

Query Parameters

Name Description Format Optional
q Finder name. Value must be entity. String No
entity URN for the entity that contains a video and whose type should be ugcPost or share. URN. For example, urn:li:ugcPost:6443156446455693312. No
queryType Type of analytics requested. String. Options: VIDEO_PLAY, VIDEO_VIEWER, VIDEO_WATCH_TIME. No
aggregation Type of aggregation. String. Options: DAILY: The query result will be a list of data points with metric counts broken down by day for the content. TOTAL (default): The query result will be a single data point with the total number of metric counts for the content. Yes
dateRange The time range for fetching analytics. The time range for which the analytics will be fetched. If missing, it will return analytics for the lifetime of the video. It is an object with start and end fields holding the start and end date/time. The time range is inclusive of the start and exclusive of the end. The start and end fields are both optional. Yes

Response Body Fields

Field Name Type Description Required
targetEntity URN URN for the post entity with type ugcPost or share, e.g., urn:li:ugcPost:123. Yes
count Long The value of analytics returned for all available metrics. Data is best-effort accurate and shouldn't be used for billing purposes. Yes
metricType String Type of analytics metrics returned. Options: VIDEO_PLAY, VIDEO_VIEWER, VIDEO_WATCH_TIME. Yes
dateRange Object The time range for fetching analytics. If missing, returns analytics for the lifetime of the post. No

DateRange Object Schema

Field Name Type Description Required
dateRange.start Object Inclusive starting date (year, month, day format). No
dateRange.start.year Integer Inclusive starting year. Yes, if dateRange.start is present.
dateRange.start.month Integer Inclusive starting month. Yes, if dateRange.start is present.
dateRange.start.day Integer Inclusive starting day. Yes, if dateRange.start is present.
dateRange.end Object Exclusive ending date (year, month, day format). Defaults to the current date. No
dateRange.end.year Integer Exclusive ending year. Yes, if dateRange.start is present.
dateRange.end.month Integer Exclusive ending month. Yes, if dateRange.start is present.
dateRange.end.day Integer Exclusive ending day. Yes, if dateRange.start is present.

Sample Request

To fetch the daily video plays count of a post owned by the current member from 2024/05/04 to 2024/05/06.

Note

For the entity parameter, if the URN is a ugcPostUrn, use entity=(ugc:urn%3Ali%3AugcPost%3A7325786486870552578). If the URN is a shareUrn, use entity=(share:urn%3Ali%3Ashare%3A7325786486870552578).

Restli 2.0:

GET https://api.linkedin.com/rest/memberCreatorVideoAnalytics?q=entity&entity=(share:urn%3Ali%3Ashare%3A7325786486870552578)&queryType=VIDEO_PLAY&aggregation=DAILY&dateRange=(start:(day:4,month:5,year:2024),end:(day:6,month:5,year:2024))

Sample Response

{
    "elements": [
        {
            "count": 7852,
            "metricType": "VIDEO_PLAY",
            "targetEntity": {
                "share": "urn:li:share:7325786486870552578"
            },
            "dateRange": {
                "start": {
                    "month": 5,
                    "day": 4,
                    "year": 2024
                },
                "end": {
                    "month": 5,
                    "day": 5,
                    "year": 2024
                }
            }
        },
        {
            "count": 9876,
            "metricType": "VIDEO_PLAY",
            "targetEntity": {
                "share": "urn:li:share:7325786486870552578"
            },
            "dateRange": {
                "start": {
                    "month": 5,
                    "day": 5,
                    "year": 2024
                },
                "end": {
                    "month": 5,
                    "day": 6,
                    "year": 2024
                }
            }
        }
    ],
    "paging": {
        "count": 10,
        "start": 0,
        "links": []
    }
}

API Error Details

HTTP STATUS CODE ERROR MESSAGE ERROR DESCRIPTION RESOLUTION
500 Unsupported video metric type: xxx for non-video post The user requested video-related metrics, but the requested post doesn't contain a video. Update the requested metric type or entity URN.
500 Internal server error. Intermittent LinkedIn server error. Please try again.
  • Last updated on