List Person Filters

Endpoint Details

URL: https://api.profileapi.com/2024-03-01/person-filters

HTTP Method: GET

Overview

This endpoint retrieves a list of filters tailored to classify and analyze individual data effectively, based on specified search criteria.

Request Parameters

Parameter	Type	Description	Required
query	string	A string containing search terms to filter filters.	Yes
categoryKey	personFilterCategory.key	The person filter category key.	Yes
limit	integer	Specifies the maximum number of results to return. Maximum is 1000. Default is 10.	No
fields	Array of strings	Name of the fields to include other than filterCategoryKey and name such as description and count.	No

Response Structure

The response includes metadata and a data array of Person Filter objects.

JSON Structure

{
  "meta": {
    "next-start": "string"
  },
  "data": [
    {
      "categoryKey": "topicsOfInterest",
      "name": "Social Selling",
      "description": "Focuses on techniques and strategies for effective social selling within professional networks.",
      "count": 3200000
    }
  ]
}

Example Response

{
  "meta": {
    "next-start": "next value"
  },
  "data": [
    {
      "categoryKey": "topicsOfInterest",
      "name": "Social Selling",
      "description": "Emphasizes methods and strategies used in social selling applicable in professional settings.",
      "count": 3200000
    }
  ]
}

Notes

• Search Query: The search query encompasses alternative names in the search results to ensure comprehensive filtering.
• Update Frequency: Data updates are performed daily to maintain relevance and accuracy.

Example Usage

cURL

curl '<https://api.profileapi.com/2024-03-01/person-filters?query=selling&limit=10>'

Node.js (Using Axios)

const axios = require('axios');

axios.get('<https://api.profileapi.com/2024-03-01/person-filters>', {
    params: {
      query: 'selling',
      limit: 10
    }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching data:', error);
});

Python (Using requests)

import requests

params = {
  'query': 'selling',
  'limit': 10
}
response = requests.get('<https://api.profileapi.com/2024-03-01/person-filters>', params=params)
if response.status_code == 200:
    print(response.json())
else:
    print('Failed to fetch data:', response.status_code)