Attribute filters

This section covers all the details about the attribute filters. This input data can be specified within the matches field in the search request object. Please refer to the Attribute Filters article in the Help Center to know more about the attribute filters functionalities.

Search flow

matches.filters enable you to reduce the universe of searched parts to find them faster, especially when searching for a part with distinct attributes such as diameter, provider, manufacturer, voltage, or material. Partium can leverage any attribute associated with a part. For example, [{"label": "Category", "values": ["Fuse"]}]

These filters can be used in combination with the Smart Filters to enhance your search capabilities and improve the user experience.

HTTP
Python
JavaScript

> POST https://api.partium.io/1/find/search
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
> Content-Length: 210
> 
> {
>   "language": "en",
>   "projection": ["results.id", "results.name"],
>   "matches": {
>      "organization": "<<Your Organization Name>>",
>      "filters": [{"label": "Manufacturer", "value": ["ACME Corp."]}]
>   }
> }
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 347
<
< {
<   "sessionId": "85394b80-f319-45cc-b98a-399d8f9f6f5e",
<   "imageId": null,
<   "results": [
<     {
<       "id": "PM19239.AD",
<       "name": "HERRINGBONE GEAR 25 millimetre"
<     },
<     {
<       "id": "PM19245.AD",
<       "name": "ZEROL BEVEL GEAR 25 millimetre"
<     },
<     {
<       "id": "PM19247.AD",
<       "name": "SCREW GEAR 25 millimetre"
<     }
<   ]
< }

response = requests.post(
  'https://api.partium.io/1/find/search',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    'language': 'en',
    'projection': ['results.id', 'results.name'],
    'matches': {
      'organization': '<<Your Organization Name>>',
      'filters': [{'label': 'Manufacturer', 'values': ['ACME Corp.']}],
    },
  },
)

fetch('https://api.partium.io/1/find/search', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    language: 'en',
    projection: ['results.id', 'results.name'],
    matches: {
      organization: '<<Your Organization Name>>',
      filters: [{label: 'Manufacturer', values: ['ACME Corp.']}],
    },
  },
}).then(res => {
  ...
});

note

Replace <<Your Organization Name>> with the provided organization name.

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

Browsing available attributes

The current available attributes and options can be browsed by the client application by using the auxiliary /1/find/filters/attributes and /1/find/filters/filters/options endpoints.

Both of the endpoints support text filtering, via the query query parameter.

The response is paginated. The results property contains a single page of results. The default pageSize query parameter is 20 and can be adjusted respecting 1 <= pageSize <= 100. To fetch additional results, the next link property must be followed. When there are no more results, next will be set to null.

HTTP
Python
JavaScript

> GET https://api.partium.io/1/find/filters/attributes
> Authorization: Bearer <<Your Access Token or API Key>>
> 
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 188
<
< {
<   "results": [
<     {
<       "label": "Category"
<     },
<     {
<       "label": "Manufacturer"
<     }
<   ],
<   "next": "https://api.partium.io/1/find/filters/attributes?cursor=abcef=="
< }
<
> GET https://api.k8s.int.partium.io/1/find/filters/attributes/options?filterLabel=Category&query=fus
> Authorization: Bearer <<Your Access Token or API Key>>
>
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 219
<
< {
<   "results": [
<     {
<       "value": "Fuse",
<       "count": "102934"
<     },
<     {
<       "value": "Fuselage",
<       "count": "10223"
<     },
<     {
<       "value": "Fusili",
<       "count": "10"
<     }
<   ],
<   "next": null
< }
<
> POST https://api.k8s.int.partium.io/1/find/search
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
> Content-Length: 123
> 
> {
>   "language": "en",
>   "projection": ["results.id", "results.name"],
>   "matches": {
>      "filters": [{"label": "Category", "values": ["Fuse"]}]
>   }
> }
>

filtersResponse = requests.get(
  'https://api.partium.io/1/find/filters/attributes',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
)
attributes = filtersResponse.json()['results']
...
subTreeResponse = requests.get(
  'https://api.partium.io/1/find/filters/attributes/options',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  params={
    'filterLabel': filters[0]['label'],
    'query': 'fus',
  },
)
options = subTreeResponse.json()['results']
...
response = requests.post(
  'https://api.partium.io/1/find/search',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    'language': 'en',
    'projection': ['results.id', 'results.name'],
    'matches': {
      'filters': [{'label': filters[0]['label'], 'values': [options[0]['value']]}],
    },
  },
)

let attributes = [];
fetch('https://api.partium.io/1/find/filters/attributes', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
}).then(res => {
  attributes = res.results;
});
...
let options = [];
fetch('https://api.partium.io/1/find/filters/attribute/options?' + (new URLSearchParams({filterLabel: attributes[0]['label'], query: 'fus'}).toString()), {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
}).then(res => {
  options = res.results;
});
...
fetch('https://api.partium.io/1/find/search', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    language: 'en',
    projection: ['results.id', 'results.name'],
    matches: {',
      filters: [{label: attributes[0].label, values: [options[0].value]}]
    },
  },
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

Search flow​

Browsing available attributes​

Search flow

Browsing available attributes