Common Parameter Types

The following types of parameter are used in many strategies for the LinkedIn Engagement Insights data source.

Period

Sets the time period to be analyzed by the strategy.

The two valid values for the parameter are 7days, and 28days. If not specified the analysis period will default to 28days.

Analysis is performed from midnight GMT for complete days. For example if you analyze 28 days, the period analyzed will end on midnight GMT of the date the task is submitted, and will start on midnight GMT of 28 days beforehand.

Sort by

Sets the output field to sort results by in descending order.

For most strategies valid values for the parameter are engagement_ratio, unique_authors, and interactions. If not specified engagement_ratio will be used.

Some strategies support additional fields for sorting. If so, these are explained on the strategy's documentation page.

Audience

Specifies an audience for analysis, based upon demographic segments.

You must use valid demographic segments values when specifying an audience to analyze.

If values are not given for a demographic dimension then all segments of the demographic are included in the analysis. For example, if no countries are specified then activity from members in all countries is included in the analysis.

When you supply an audience parameter, you must specify values for at least one demographic dimension.

Property Type Required Description Example
seniorities array(string) No. Up to 10 items segments can be specified. Seniority level of members to include. ["vp", "manager"]
countries array(string) No. Up to 10 items segments can be specified. Countries of members to include. ["united states", "united kingdom"]
functions array(string) No. Up to 10 items segments can be specified. Job functions of members to include. ["accounting", "administrative"]
sectors array(string) No. Up to 10 items segments can be specified. Industry sectors of members to include. ["finance", "legal"]
industries array(string) No. Up to 10 items segments can be specified. Industry names of members to include. ["computer software", "computer hardware"]
company_sizes array(string) No. Up to 9 items segments can be specified. Sizes of members' employers to include. ["5001-10000", "10000+"]
custom_segments array(string) No. Up to 10 items segments can be specified. Include members who belong to these custom segments. ("13 plus years of experience", "business traveler"]

For example the following audience parameter specifies decision makers in the UK and Germany:

{
    "audience": {
        "countries": ["united kingdom", "germany"],
        "seniorities": ["director", "vp", "cxo", "partner", "owner"]
    }
}

Keywords

Specifies a topic for analysis, based upon keywords appearing in the title or summary of content.

The keywords parameter type supports the following fields:

Property Type Required Description Example
all array(string) At least one of 'all' and 'any' must be given Content title or summary must include ALL these terms. ["ford", "mondeo"]
any array(string) At least one of 'all' and 'any' must be given Content title or summary must include AT LEAST ONE of these terms. ["review", "performance", "rating"]
none array(string) No Content title or summary MUST NOT mention ANY of these terms. ["special offer", "sale"]

For example the following keywords parameter specifies a topic for reviews of Ford Mondeos:

{
    "keywords": {
        "all": ["ford", "mondeo"],
        "any": ["review", "performance", "rating"],
        "none": ["special offer", "sale"]
    }
}

Concepts

Specifies a topic for analysis, based upon concepts mentioned in the body of content.

The concepts parameter type supports the following fields:

Property Type Required Description Example
all array(string) At least one of 'all' and 'any' must be given Content body must mention ALL of these concepts. ["ford", "mondeo"]
any array(string) At least one of 'all' and 'any' must be given Content body must mention AT LEAST ONE of these concepts. ["review", "performance", "rating"]
none array(string) No Content body MUST NOT mention ANY of these concepts. ["special offer", "sale"]

The idea of concepts is explained in detail in the Working with Concepts guide for the data source.

When specifying a concept you can use either a string which represents a concept name (with no type specified), or a 2 item string array representing a concept with of a specified type. For example:

  • IBM - will match concepts with the name 'IBM' regardless of the concept type.
  • ["company", "IBM"] - will match only the concept of name 'IBM' with type 'company'.

For example the following concepts parameter specifies a topic for instant messaging:

{
    "concepts": {
        "all": ["Instant_messaging"],
        "any": ("product", "Skype"], "Microsoft"],
        "none": ["IBM"]
    }
}

This will match content that:

  • includes a mention of the 'Instant_messaging' concept (regardless of concept type).
  • includes a mention the Skype product concept or the Microsoft concept.
  • does not mention the IBM concept.

Comparison audience

Specifies the audience to compare your analyzed audience to.

The value of the parameter can be either global (meaning compare to the entire LinkedIn audience), or an object containing one of the following properties:

Property Type Description Example
country string Compare results to the audience in this country. united kingdom
minor_continent string Compare results to the audience in this minor continent. western europe