openapi: 3.1.0
info:
title: LinkedIn Compliance Events Access Control Fetch Media Plan API
description: LinkedIn provides Compliance API Guides for monitoring, archiving, and management of communications for enterprises in regulated industries. The Compliance Events API allows applications to archive all LinkedIn activities from the past 30 days of a regulated, authenticated member.
version: 1.0.0
contact:
name: LinkedIn API Support
url: https://docs.microsoft.com/en-us/linkedin/compliance/
servers:
- url: https://api.linkedin.com
description: LinkedIn Production API Server
security:
- OAuth2Auth:
- r_compliance
tags:
- name: Fetch Media Plan
description: Media Planning API can help Media Planners understand the reach and ROI that LinkedIn can offer to their client. It allows them to make budget allocation recommendations with confidence and know how to improve the results, even before spending the first dollar. Media Planning API helps Media Planners make that decision by giving the forecasted reach, impressions (and more in future, like clicks, leads) curve over the budget, based on inputs provided like targeted audience, campaign start/end date and more.
paths:
/mediaPlanning:
post:
tags:
- Fetch Media Plan
summary: LinkedIn Forecast Avg Lifetime Frequency
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ForecastAvgLifetimeFrequencyRequest'
parameters:
- name: Authorization
in: header
schema:
type: string
example: Bearer {{Access_Token}}
- name: X-RestLi-Protocol-Version
in: header
schema:
type: string
example: 2.0.0
- name: Linkedin-Version
in: header
schema:
type: string
example: '{{insert_version}}'
- name: action
in: query
schema:
type: string
example: forecastImpressions
responses:
undefined:
content:
text/plain:
examples:
default:
$ref: '#/components/examples/ForecastAvgLifetimeFrequencyResponseundefinedExample'
schema:
$ref: '#/components/schemas/ForecastAvgLifetimeFrequencyResponseundefined'
operationId: postForecastAvgLifetimeFrequency
x-microcks-operation:
dispatcher: FALLBACK
dispatcherRules: '{}'
delay: 0
components:
examples:
ForecastAvgLifetimeFrequencyResponseundefinedExample:
summary: Example undefined response for ForecastAvgLifetimeFrequency
value: "{\n \"value\": {\n \"averageFrequency\": {\n \"metricCurve\": [],\n \"singlePointMetric\": {\n \"metricValue\": 1.8164758594903745,\n \"budgetMicros\": 300000000\n }\n },\n \"impressionCurve\": {\n \"metricCurve\": [\n {\n \"metricUpper\": 41043.86773686674,\n \"metricValue\": 34203.22265625,\n \"budgetMicros\": 100000000,\n \"metricLower\": 27362.57781168749\n },\n {\n \"metricUpper\": 44137.06060459373,\n \"metricValue\": 36780.8828125,\n \"budgetMicros\": 108898986,\n \"metricLower\": 29424.706338958636\n },\n {\n \"metricUpper\": 47193.100333790324,\n \"metricValue\": 39327.58203125,\n \"budgetMicros\": 117797981,\n \"metricLower\": 31462.06610782465\n },\n {\n \"metricUpper\": 50215.1916253171,\n \"metricValue\": 41845.9921875,\n \"budgetMicros\": 126696968,\n \"metricLower\": 33476.793585472864\n },\n {\n \"metricUpper\": 53206.06663343318,\n \"metricValue\": 44338.38671875,\n \"budgetMicros\": 135595962,\n \"metricLower\": 35470.7102080308\n },\n {\n \"metricUpper\": 56168.063824241995,\n \"metricValue\": 46806.71875,\n \"budgetMicros\": 144494949,\n \"metricLower\": 37445.37495286201\n },\n {\n \"metricUpper\": 59103.22017574705,\n \"metricValue\": 49252.6796875,\n \"budgetMicros\": 153393936,\n \"metricLower\": 39402.14580526844\n },\n {\n \"metricUpper\": 62013.31725117974,\n \"metricValue\": 51677.76171875,\n \"budgetMicros\": 162292922,\n \"metricLower\": 41342.210474041545\n },\n {\n \"metricUpper\": 64899.932261183494,\n \"metricValue\": 54083.2734375,\n \"budgetMicros\": 171191925,\n \"metricLower\": 43266.62043291748\n },\n {\n \"metricUpper\": 67764.4524833402,\n \"metricValue\": 56470.375,\n \"budgetMicros\": 180090911,\n \"metricLower\": 45176.30053359452\n },\n {\n \"metricUpper\": 70608.13213893079,\n \"metricValue\": 58840.10546875,\n \"budgetMicros\": 188989898,\n \"metricLower\": 47072.08692357255\n },\n {\n \"metricUpper\": 73432.09443938629,\n \"metricValue\": 61193.41015625,\n \"budgetMicros\": 197888885,\n \"metricLower\": 48954.72841045364\n },\n {\n \"metricUpper\": 76237.35436244348,\n \"metricValue\": 63531.125,\n \"budgetMicros\": 206787872,\n \"metricLower\": 50824.90164604551\n },\n {\n \"metricUpper\": 79024.8380503867,\n \"metricValue\": 65854.03125,\n \"budgetMicros\": 215686874,\n \"metricLower\": 52683.22405852238\n },\n {\n \"metricUpper\": 81795.37585541926,\n \"metricValue\": 68162.8125,\n \"budgetMicros\": 224585861,\n \"metricLower\": 54530.24921600606\n },\n {\n \"metricUpper\": 84549.74115724923,\n \"metricValue\": 70458.1171875,\n \"budgetMicros\": 233484848,\n \"metricLower\": 56366.49270495576\n },\n {\n \"metricUpper\": 87288.6397573277,\n \"metricValue\": 72740.53125,\n \"budgetMicros\": 242383834,\n \"metricLower\": 58192.425059660556\n },\n {\n \"metricUpper\": 90012.72191610772,\n \"metricValue\": 75010.6015625,\n \"budgetMicros\": 251282821,\n \"metricLower\": 60008.47978707836\n },\n {\n \"metricUpper\": 92722.59316814205,\n \"metricValue\": 77268.8203125,\n \"budgetMicros\": 260181823,\n \"metricLower\": 61815.060576900985\n },\n {\n \"metricUpper\": 95418.80106550577,\n \"metricValue\": 79515.6640625,\n \"budgetMicros\": 269080810,\n \"metricLower\": 63612.532463836105\n },\n {\n \"metricUpper\": 98101.86763386156,\n \"metricValue\": 81751.5546875,\n \"budgetMicros\": 277979797,\n \"metricLower\": 65401.24346498351\n },\n {\n \"metricUpper\": 100772.27473456184,\n \"metricValue\": 83976.890625,\n \"budgetMicros\": 286878784,\n \"metricLower\": 67181.51482123685\n },\n {\n \"metricUpper\": 103430.47218435147,\n \"metricValue\": 86192.0546875,\n \"budgetMicros\": 295777770,\n \"metricLower\": 68953.64641041857\n },\n {\n \"metricUpper\": 106076.88078523756,\n \"metricValue\": 88397.3984375,\n \"budgetMicros\": 304676757,\n \"metricLower\": 70717.91876719311\n },\n {\n \"metricUpper\": 108711.89498782855,\n \"metricValue\": 90593.2421875,\n \"budgetMicros\": 313575744,\n \"metricLower\": 72474.59485862624\n },\n {\n \"metricUpper\": 111335.8942216552,\n \"metricValue\": 92779.90625,\n \"budgetMicros\": 322474761,\n \"metricLower\": 74223.92763773221\n },\n {\n \"metricUpper\": 113949.20902064291,\n \"metricValue\": 94957.671875,\n \"budgetMicros\": 331373748,\n \"metricLower\": 75966.13746045575\n },\n {\n \"metricUpper\": 116552.17686262178,\n \"metricValue\": 97126.8125,\n \"budgetMicros\": 340272735,\n \"metricLower\": 77701.44931201139\n },\n {\n \"metricUpper\": 119145.10778851826,\n \"metricValue\": 99287.5859375,\n \"budgetMicros\": 349171722,\n \"metricLower\": 79430.06988634494\n },\n {\n \"metricUpper\": 121728.29489511793,\n \"metricValue\": 101440.2421875,\n \"budgetMicros\": 358070709,\n \"metricLower\": 81152.19458130863\n },\n {\n \"metricUpper\": 124302.01565869885,\n \"metricValue\": 103585.0078125,\n \"budgetMicros\": 366969696,\n \"metricLower\": 82868.00838108321\n },\n {\n \"metricUpper\": 126866.53312570408,\n \"metricValue\": 105722.109375,\n \"budgetMicros\": 375868682,\n \"metricLower\": 84577.68664995971\n },\n {\n \"metricUpper\": 129422.09698663955,\n \"metricValue\": 107851.7421875,\n \"budgetMicros\": 384767669,\n \"metricLower\": 86281.39584827129\n },\n {\n \"metricUpper\": 131968.94454708393,\n \"metricValue\": 109974.1171875,\n \"budgetMicros\": 393666656,\n \"metricLower\": 87979.2941797331\n },\n {\n \"metricUpper\": 134507.3016077688,\n \"metricValue\": 112089.4140625,\n \"budgetMicros\": 402565643,\n \"metricLower\": 89671.53217816251\n },\n {\n \"metricUpper\": 137037.39192660234,\n \"metricValue\": 114197.8203125,\n \"budgetMicros\": 411464660,\n \"metricLower\": 91358.25901549454\n },\n {\n \"metricUpper\": 139559.40326904142,\n \"metricValue\": 116299.5,\n \"budgetMicros\": 420363647,\n \"metricLower\": 93039.59986869738\n },\n {\n \"metricUpper\": 142073.54012999576,\n \"metricValue\": 118394.609375,\n \"budgetMicros\": 429262634,\n \"metricLower\": 94715.69106770742\n },\n {\n \"metricUpper\": 144579.9896073259,\n \"metricValue\": 120483.3203125,\n \"budgetMicros\": 438161621,\n \"metricLower\": 96386.6573444286\n },\n {\n \"metricUpper\": 147078.93064832062,\n \"metricValue\": 122565.7734375,\n \"budgetMicros\": 447060607,\n \"metricLower\": 98052.61799705052\n },\n {\n \"metricUpper\": 149570.53455976973,\n \"metricValue\": 124642.109375,\n \"budgetMicros\": 455959594,\n \"metricLower\": 99713.68723009682\n },\n {\n \"metricUpper\": 152054.96547679233,\n \"metricValue\": 126712.46875,\n \"budgetMicros\": 464858581,\n \"metricLower\": 101369.97446697755\n },\n {\n \"metricUpper\": 154532.38079448088,\n \"metricValue\": 128776.9765625,\n \"budgetMicros\": 473757568,\n \"metricLower\": 103021.58463775172\n },\n {\n \"metricUpper\": 157002.93156595255,\n \"metricValue\": 130835.7734375,\n \"budgetMicros\": 482656555,\n \"metricLower\": 104668.61844449499\n },\n {\n \"metricUpper\": 159466.76286999346,\n \"metricValue\": 132888.96875,\n \"budgetMicros\": 491555541,\n \"metricLower\": 106311.17260639564\n },\n {\n \"metricUpper\": 161924.02256672797,\n \"metricValue\": 134936.671875,\n \"budgetMicros\": 500454559,\n \"metricLower\": 107949.34569686753\n },\n {\n \"metricUpper\": 164374.82792834207,\n \"metricValue\": 136979.015625,\n \"budgetMicros\": 509353546,\n \"metricLower\": 109583.21589736595\n },\n {\n \"metricUpper\": 166819.30811870715,\n \"metricValue\": 139016.078125,\n \"budgetMicros\": 518252502,\n \"metricLower\": 111212.86931713649\n },\n {\n \"metricUpper\": 169257.60424598938,\n \"metricValue\": 141048.0,\n \"budgetMicros\": 527151489,\n \"metricLower\": 112838.40002828748\n },\n {\n \"metricUpper\": 171689.82775588235,\n \"metricValue\": 143074.84375,\n \"budgetMicros\": 536050476,\n \"metricLower\": 114459.88232794618\n },\n {\n \"metricUpper\": 174116.11084045368,\n \"metricValue\": 145096.75,\n \"budgetMicros\": 544949523,\n \"metricLower\": 116077.40434415545\n },\n {\n \"metricUpper\": 176536.53174077353,\n \"metricValue\": 147113.765625,\n \"budgetMicros\": 553848510,\n \"metricLower\": 117691.01823762749\n },\n {\n \"metricUpper\": 178951.21479601107,\n \"metricValue\": 149126.0,\n \"budgetMicros\": 562747497,\n \"metricLower\": 119300.80690113964\n },\n {\n \"metricUpper\": 181360.26403087392,\n \"metricValue\": 151133.546875,\n \"budgetMicros\": 571646484,\n \"metricLower\": 120906.83968449528\n },\n {\n \"metricUpper\": 183763.77999568728,\n \"metricValue\": 153136.484375,\n \"budgetMicros\": 580545471,\n \"metricLower\": 122509.18362124286\n },\n {\n \"metricUpper\": 186161.85993386965,\n \"metricValue\": 155134.875,\n \"budgetMicros\": 589444458,\n \"metricLower\": 124107.90354032649\n },\n {\n \"metricUpper\": 188554.59793893123,\n \"metricValue\": 157128.828125,\n \"budgetMicros\": 598343444,\n \"metricLower\": 125703.06217075135\n },\n {\n \"metricUpper\": 190942.08510179608,\n \"metricValue\": 159118.390625,\n \"budgetMicros\": 607242431,\n \"metricLower\": 127294.72023979864\n },\n {\n \"metricUpper\": 193324.40964917772,\n \"metricValue\": 161103.671875,\n \"budgetMicros\": 616141418,\n \"metricLower\": 128882.93656527596\n },\n {\n \"metricUpper\": 195701.65707367274,\n \"metricValue\": 163084.703125,\n \"budgetMicros\": 625040405,\n \"metricLower\": 130467.76814224626\n },\n {\n \"metricUpper\": 198073.91025617882,\n \"metricValue\": 165061.578125,\n \"budgetMicros\": 633939392,\n \"metricLower\": 132049.27022463994\n },\n {\n \"metricUpper\": 200441.2495811911,\n \"metricValue\": 167034.375,\n \"budgetMicros\": 642838378,\n \"metricLower\": 133627.49640211914\n },\n {\n \"metricUpper\": 202803.75304548448,\n \"metricValue\": 169003.125,\n \"budgetMicros\": 651737365,\n \"metricLower\": 135202.49867253247\n },\n {\n \"metricUpper\": 205161.496360646,\n \"metricValue\": 170967.90625,\n \"budgetMicros\": 660636352,\n \"metricLower\": 136774.32751027\n },\n {\n \"metricUpper\": 207514.5530498834,\n \"metricValue\": 172928.78125,\n \"budgetMicros\": 669535339,\n \"metricLower\": 138343.0319308024\n },\n {\n \"metricUpper\": 209862.99453950126,\n \"metricValue\": 174885.828125,\n \"budgetMicros\": 678434326,\n \"metricLower\": 139908.65955166487\n },\n {\n \"metricUpper\": 212206.89024540473,\n \"metricValue\": 176839.0625,\n \"budgetMicros\": 687333312,\n \"metricLower\": 141471.25665012634\n },\n {\n \"metricUpper\": 214546.3076549613,\n \"metricValue\": 178788.578125,\n \"budgetMicros\": 696232299,\n \"metricLower\": 143030.86821776401\n },\n {\n \"metricUpper\": 216881.31240452663,\n \"metricValue\": 180734.421875,\n \"budgetMicros\": 705131286,\n \"metricLower\": 144587.53801214724\n },\n {\n \"metricUpper\": 219211.96835291517,\n \"metricValue\": 182676.640625,\n \"budgetMicros\": 714030273,\n \"metricLower\": 146141.30860581793\n },\n {\n \"metricUpper\": 221538.3535922993,\n \"metricValue\": 184615.28125,\n \"budgetMicros\": 722929321,\n \"metricLower\": 147692.23206022306\n },\n {\n \"metricUpper\": 223860.4967206563,\n \"metricValue\": 186550.40625,\n \"budgetMicros\": 731828308,\n \"metricLower\": 149240.32744068038\n },\n {\n \"metricUpper\": 226178.47263864023,\n \"metricValue\": 188482.046875,\n \"budgetMicros\": 740727294,\n \"metricLower\": 150785.64468095795\n },\n {\n \"metricUpper\": 228492.33875719862,\n \"metricValue\": 190410.28125,\n \"budgetMicros\": 749626281,\n \"metricLower\": 152328.2220550199\n },\n {\n \"metricUpper\": 230802.1510247141,\n \"metricValue\": 192335.125,\n \"budgetMicros\": 758525268,\n \"metricLower\": 153868.09686178702\n },\n {\n \"metricUpper\": 233107.96398097326,\n \"metricValue\": 194256.625,\n \"budgetMicros\": 767424255,\n \"metricLower\": 155405.30546111614\n },\n {\n \"metricUpper\": 235409.8308085415,\n \"metricValue\": 196174.84375,\n \"budgetMicros\": 776323242,\n \"metricLower\": 156939.88330805\n },\n {\n \"metricUpper\": 237707.8033816974,\n \"metricValue\": 198089.828125,\n \"budgetMicros\": 785222229,\n \"metricLower\": 158471.86498544004\n },\n {\n \"metricUpper\": 240001.93231306836,\n \"metricValue\": 200001.609375,\n \"budgetMicros\": 794121215,\n \"metricLower\": 160001.2842350372\n },\n {\n \"metricUpper\": 242292.26699810033,\n \"metricValue\": 201910.21875,\n \"budgetMicros\": 803020202,\n \"metricLower\": 161528.17398713776\n },\n {\n \"metricUpper\": 244578.85565748473,\n \"metricValue\": 203815.703125,\n \"budgetMicros\": 811919189,\n \"metricLower\": 163052.56638886864\n },\n {\n \"metricUpper\": 246861.74537765826,\n \"metricValue\": 205718.109375,\n \"budgetMicros\": 820818176,\n \"metricLower\": 164574.4928311869\n },\n {\n \"metricUpper\": 249140.98214948268,\n \"metricValue\": 207617.484375,\n \"budgetMicros\": 829717163,\n \"metricLower\": 166093.98397466622\n },\n {\n \"metricUpper\": 251416.6109052052,\n \"metricValue\": 209513.828125,\n \"budgetMicros\": 838616149,\n \"metricLower\": 167611.06977413732\n },\n {\n \"metricUpper\": 253688.675553793,\n \"metricValue\": 211407.21875,\n \"budgetMicros\": 847515136,\n \"metricLower\": 169125.77950224432\n },\n {\n \"metricUpper\": 255957.21901473028,\n \"metricValue\": 213297.671875,\n \"budgetMicros\": 856414123,\n \"metricLower\": 170638.14177197588\n },\n {\n \"metricUpper\": 258222.2832503593,\n \"metricValue\": 215185.234375,\n \"budgetMicros\": 865313110,\n \"metricLower\": 172148.1845582262\n },\n {\n \"metricUpper\": 260483.9092968432,\n \"metricValue\": 217069.921875,\n \"budgetMicros\": 874212097,\n \"metricLower\": 173655.93521843676\n },\n {\n \"metricUpper\": 262742.13729382225,\n \"metricValue\": 218951.765625,\n \"budgetMicros\": 883111083,\n \"metricLower\": 175161.420512367\n },\n {\n \"metricUpper\": 264997.00651283126,\n \"metricValue\": 220830.828125,\n \"budgetMicros\": 892010070,\n \"metricLower\": 176664.6666210395\n },\n {\n \"metricUpper\": 267248.5708158581,\n \"metricValue\": 222707.140625,\n \"budgetMicros\": 900909118,\n \"metricLower\": 178165.7094524452\n },\n {\n \"metricUpper\": 269496.83693381876,\n \"metricValue\": 224580.6875,\n \"budgetMicros\": 909808105,\n \"metricLower\": 179664.5534938615\n },\n {\n \"metricUpper\": 271741.8571469351,\n \"metricValue\": 226451.53125,\n \"budgetMicros\": 918707092,\n \"metricLower\": 181161.23359876857\n },\n {\n \"metricUpper\": 273983.6675158626,\n \"metricValue\": 228319.71875,\n \"budgetMicros\": 927606079,\n \"metricLower\": 182655.77380760296\n },\n {\n \"metricUpper\": 276222.30335875484,\n \"metricValue\": 230185.25,\n \"budgetMicros\": 936505065,\n \"metricLower\": 184148.1976657997\n },\n {\n \"metricUpper\": 278457.7992734573,\n \"metricValue\": 232048.15625,\n \"budgetMicros\": 945404052,\n \"metricLower\": 185638.52823858862\n },\n {\n \"metricUpper\": 280690.18915883615,\n \"metricValue\": 233908.484375,\n \"budgetMicros\": 954303039,\n \"metricLower\": 187126.78812521315\n },\n {\n \"metricUpper\": 282919.5062352819,\n \"metricValue\": 235766.25,\n \"budgetMicros\": 963202026,\n \"metricLower\": 188612.99947259983\n },\n {\n \"metricUpper\": 285145.78306442837,\n \"metricValue\": 237621.484375,\n \"budgetMicros\": 972101013,\n \"metricLower\": 190097.18398850405\n },\n {\n \"metricUpper\": 287369.0515681234,\n \"metricValue\": 239474.203125,\n \"budgetMicros\": 981000000,\n \"metricLower\": 191579.36295415703\n }\n ],\n \"singlePointMetric\": {\n \"metricUpper\": 104687.53540990874,\n \"metricValue\": 87239.609375,\n \"budgetMicros\": 300000000,\n \"metricLower\": 69791.68853997719\n }\n }\n }\n}"
schemas:
ForecastAvgLifetimeFrequencyResponseundefined:
type: string
ForecastAvgLifetimeFrequencyRequest:
type: object
example:
request:
sponsoredAccountUrn: urn:li:sponsoredAccount:{{sponsoredaccount_id}}
targetingCriteria:
include:
and:
- or:
urn:li:adTargetingFacet:ageRanges:
- urn:li:ageRange:(18,24)
- or:
urn:li:adTargetingFacet:locations:
- urn:li:geo:103644278
targetBudgetMicros: 300000000
optimizationType: MAX_REACH
objectiveType: BRAND_AWARENESS
enableAudienceExpansion: true
enableAudienceNetwork: true
startDateOn:
day: 1
month: 4
year: 2024
endDateOn:
day: 1
month: 5
year: 2024
securitySchemes:
OAuth2Auth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://www.linkedin.com/oauth/v2/authorization
tokenUrl: https://www.linkedin.com/oauth/v2/accessToken
scopes:
r_compliance: Read compliance data