New Reference Data API: Building simple user interfaces for faster insights has never been easier

Richard Caudle
14th July 2017 0 Comments

With the unveiling of our Media Strategies API last month, we set out to simplify the analysis of social data so that actionable insights could be surfaced from networks faster. Using the API, application builders can immediately access common insights from LinkedIn data and quickly build in-depth reports for their users. Today, we’re launching our Reference Data API to make it even easier for app builders to integrate LinkedIn Engagement Insights data into their products and build their user interface.

Now, for example, you can provide your users with dropdown lists of all of the valid filtering options supported by our Media Strategies API. What this means in practice is that your users can generate insights more quickly and accurately, without having to guess what to type into text boxes. If users wanted to define their audience, as in the image below, they can now select their country, seniority, job function and more from dropdown lists.


The following individual sets of reference data will be made available in the first release of the feature: country, custom segments, industries, sectors, company sizes, job functions and seniorities.

You’ll be able to access data via the new reference data endpoints when you provide your username and identity API key in an Authorization header, just as you do when accessing the Media Strategies API.

GET /pylon/linkedin/reference

Calling this returns a listing of all the sets of reference data that are available.

 The endpoint will return the list of data sets in the following format:

 {
  "count": 10,
  "page": 1,
  "pages": 1,
  "per_page": 20,
  "data": [
    {
      "name": "Valid seniority values",
      "slug": "seniorities"
    },
    {
      "description": "Valid function values",
      "slug": "functions"
    },
    ...
  ]
}

Each reference data set has a slug value which you can use to retrieve the data set.

GET /pylon/linkedin/reference/<slug>

This endpoint returns the requested reference data set. For example calling the endpoint with the ‘seniorities’ slug:

GET /pylon/linkedin/reference/seniorities

Will return the list of seniority values that are valid:

 {
  "values": [
    {
      "title": "CXO",
      "value": "cxo"
    },
    {
      "title": "Director",
      "value": "director"
    },
    {
      "title": "Entry",
      "value": "entry"
    },
    ...
  ],
  "count": 11
}

For slugs that return multiple data sets in one call, the data sets will be returned in one response labelled using the slug for each individual dataset. For example the following request:

 GET /pylon/linkedin/reference/demographic_values

 Will return data in the following format:

 {
  "company_sizes": {
    "values": [
      {"title": "1-10","value": "1-10"},
      …
   ]
  },
  "ages": {
    "values": [
      {"title": "18-24", "value": "18-24"},
      …
    ]
  },
  ...
}

As you can see, each data set (ages, company sizes, etc.) is labelled using the appropriate slug.

Available reference data sets

The following individual sets of reference data will be made available in the first release of the feature:

slug Description Media Strategies API audience field
countries Valid country values countries
custom_segments Valid custom segment values custom_segments
industries Valid industry values industries
sectors Valid sector values sectors
company_sizes Valid company size values company_sizes
functions Valid function values functions
seniorities Valid seniority values seniorities
ages Valid ages values (not currently supported)
genders Valid gender values (not currently supported)
degree_groups Valid degree group values (not currently supported)
education_statuses Valid education status values (not currently supported)
field_groups Valid field groups values (not currently supported)
field_names Valid field name values (not currently supported)
minor_continents Valid minor continent values (not currently supported)

 Additionally the following ‘slugs’ return multiple sets of data in one call:

slug Description
demographic_values Returns all demographic reference data sets

The Reference Data API allows app builders to create easy-to-use interfaces customers, allowing their users to focus on finding actionable insights, rather than fixing error-prone filters.

Find out what our Media Strategies API and new Reference Data API can do for you and contact us at [email protected]

 

 

Share This