Skip to main content
Version: v3

Get reporting list

GET 
/ad-publishing/linkedin/reporting/list

Retrieve a list of LinkedIn campaigns or campaign groups with reporting data

Request​

Version stringrequired

API Version

Available optionsv3
locationId stringrequired

Location ID

listType stringrequired

List type

Available optionscampaignGroupscampaignsads
campaignId stringrequired

Campaign ID

campaignGroupId stringrequired

Campaign group ID

startDate stringrequired

Start date in yyyy-mm-dd format

endDate stringrequired

End date in yyyy-mm-dd format

fields string[]

Reporting fields. Pass as comma-separated values on the wire (e.g. ?fields=impressions,clicks).

Available optionsclicksoneClickLeadscostInLocalCurrencyimpressionscostInUsdctrcpccpmcplexternalWebsitePostClickConversionsconversionRate
application/json

Metrics per entity for the period. Identity fields vary with listType.

Schema
  • Array [
    • impressionsnumber

    Impressions

    clicksnumber

    Clicks

    oneClickLeadsnumber

    Leads captured through a one-click lead form

    externalWebsitePostClickConversionsnumber

    Conversions recorded on an external site after a click

    ctrnumbernullable

    Click-through rate as a percentage, e.g. 1.40 means 1.40%. Null when it cannot be computed.

    cpcnumbernullable

    Cost per click in the account currency. Null when it cannot be computed.

    cpmnumbernullable

    Cost per thousand impressions. Null when it cannot be computed.

    cplnumbernullable

    Cost per lead. Null when it cannot be computed.

    conversionRatenumbernullable

    Conversion rate as a percentage. Null when it cannot be computed.

    pivotValuesstring[]required

    URNs of the entity this row is pivoted on — a sponsored account, campaign group or creative depending on the request. This is not the time bucket; that is carried by dateStart/dateEnd.

    dateStartstringrequired

    First day covered by the row

    dateEndstringrequired

    Last day covered by the row

    costInUsdstring

    Spend in USD. Returned as a string on grouped rows, unlike in totals, and at full source precision — e.g. 899.99999999999988713. Parse as a decimal rather than a float.

    costInLocalCurrencystring

    Spend in the account currency. Returned as a string on grouped rows, unlike in totals, and at full source precision. Parse as a decimal rather than a float.

    _idstringrequired

    Stored record id, as _id rather than id

    namestringrequired

    Entity name

    publishingStatusstringrequired

    Publishing status

    adCampaignGroupIdstring

    LinkedIn campaign group id. Present when listType is campaignGroups.

    adCampaignIdstring

    Parent ad campaign record id. Present when listType is ads.

    adIdstring

    LinkedIn creative id. Present when listType is ads.

    campaignNamestring

    Name of the parent campaign. Present when listType is ads.

  • ]