Skip to main content
Version: v3

Get campaign group reporting

GET 
/ad-publishing/linkedin/reporting/campaign-group/:campaignGroupId

Retrieve reporting metrics for a specific LinkedIn campaign group

Request​

Version stringrequired

API Version

Available optionsv3
campaignGroupId stringrequired

Campaign group identifier

locationId stringrequired

Location 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
campaignGroupId string

Campaign group ID

application/json

Metrics for the campaign group over the period, merged with the stored campaign group

Schema
    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

    Campaign group record id, as _id rather than id

    __vnumberrequired

    Mongoose internal version key

    namestringrequired

    Campaign group name

    locationIdstringrequired

    Location identifier

    linkedInAdAccountIdstringrequired

    LinkedIn ad account id

    publishingStatusstringrequired

    Publishing status

    objectiveTypestringrequired

    Campaign objective

    Available optionsLEAD_GENERATIONWEBSITE_VISIT
    adBudgetOptimizationstring

    Budget optimisation mode

    Available optionsMAXIMUM_DELIVERYCOST_CAP
    budgetobjectrequired

    Budget configuration

    adCampaignGroupIdstring

    LinkedIn campaign group id, set once published

    linkedInErrorstringrequired

    Publish or review error. Empty string when there is none.

    createdAtstringrequired

    Created at

    updatedAtstringrequired

    Updated at