Taxonomy

Filters

• Include only records that match any of the labels

  {
    "any_label": [
      <label>,
      <label>,
      ...
    ]
  }
  

• Exclude all records that match any of the labels

  {
    "no_labels": [
      <label>,
      <label>,
      ...
    ]
  }
  

• Include only records that match any of the ranges

  {
    "any_range": [
      <range>,
      <range>,
      ...
    ]
  }
  

• Exclude all records that match any of the ranges

  {
    "no_ranges": [
      <range>,
      <range>,
      ...
    ]
  }
  

Hints:

• <label> (see: Labels)

• <range> (see: Ranges)

• <field> (see: Fields)

Labels

Entity Label is a concept …

• Match by a badge field (e.g. when Post.is_private is True)

  {"badge": {"field": <field>}}

• Match by an empty field (e.g. when Post.sections is empty)

  {"empty": {"field": <field>}}

• Match by a field value (e.g. when value in Post.sections)

  {"value": {"field": <field>, "value": <scalar>}}

Hints:

• <field> (see: Fields)

Ranges

Entity Range is a concept …

• Match by a field value more than min

  {"field": <field>, "min": <scalar>}

• Match by a field value less than max

  {"field": <field>, "max": <scalar>}

• Match by a field value in a range between min and max

  {"field": <field>, "min": <scalar>, "max": <scalar>}

Hints:

• <field> (see: Fields)

Entities

Types

• {"post": {}} – a post entity type

• {"user": {}} – a user profile entity type

GUIDs

• {"post": {"id": 12345}} – a post entity

• {"user": {"id": 34567}} – a user profile entity

Fields

Posts

• {"post-id": {}} – post ID (1..1)

• {"post-type": {}} – post type (1..1)

  • “page”

  • “image”

  • “video”

  • “event”

  • “place”

  • “how-to”

  • “recipe”

  • “product”

• {"post-status": {}} – post status (1..1)

  • “draft-created(imported=true)”

  • “draft-created(imported=false)”

  • “draft-in-progress(rejected=true)”

  • “draft-in-progress(rejected=false)”

  • “draft-in-review”

  • “draft-ready”

  • “published-to-site(promoted=true)”

  • “published-to-site(promoted=false)”

  • “published-to-community(demoted=true)”

  • “published-to-community(demoted=false)”

  • “removed”

• {"post-is-private": {}} – post privacy (0..1)

• {"post-is-suspicious": {}} – post suspicious flag (0..1)

• {"post-is-excluded-from-search": {}} – post search visibility (0..1)

• {"post-modified-at": {}} – post last modification timestamp (1..1)

• {"post-scheduled-at": {}} – post scheduled timestamp (0..1)

• {"post-published-at": {}} – post published timestamp (0..1)

• {"post-embargoed-until": {}} – post embargo timestamp (0..1)

• {"post-title": {}} – post headline (1..1)

• {"post-subtitle": {}} – a list of post sub-headlines including subheadline, twitter text, and every particle headline and headline_html (0..*)

• {"post-bodies": {}} – a list of post bodies including body and every particle body (0..*)

• {"post-primary-tag": {}} – the primary tag slug (0..1)

• {"post-regular-tag": {}} – a regular tag slug (0..*)

• {"post-primary-section": {}} – the primary section ID (0..1)

• {"post-regular-section": {}} – a regular section ID (0..*)

• {"post-community": {}} – the community ID (0..1)

• {"post-author": {}} – an author ID (1..*)

• {"post-stage": {}} – the stage ID (0..1)

• {"post-page-layout": {}} – the post page custom layout slug (0..1)

• {"post-editor-layout": {}} – the post editor custom layout slug (0..1)

• {"post-custom-field": {"path": "path.to.field"}} – a custom field value (0..*)

User Profiles

• {"user-id": {}} – user profile ID (1..1)

• {"user-email": {}} – user email (0..*)

• {"user-profile-slug": {}} – user profile slug (1..1)

• {"user-profile-title": {}} – user profile title (1..1)

• {"user-profile-owner": {}} – user ID (1..1)

• {"user-profile-status": {}} – user profile status (1..1)

  • “active”

  • “pending”

  • “inactive(banned=true)”

  • “inactive(banned=false)”

• {"user-profile-created-at": {}} – user profile creation timestamp (1..1)

• {"user-profile-about-html": {}} – user profile about HTML (1..1)

• {"user-profile-description": {}} – user profile about HTML (1..1)

• {"user-group": {}} – user group slug (0..*)

• {"user-community": {}} – user community ID (0..*)

• {"user-access-role": {}} – user access role ID (0..*)

• {"user-last-logged-in-at": {}} – user last logged in timestamp (1..1)

• {"user-custom-field": {"path": "path.to.field"}} – a custom field value (0..*)

Sections

• {"section-id": {}} – section ID (1..1)

• {"section-parent": {}} – parent section ID (0..1)

• {"section-ancestor": {}} – ancestor section ID (0..*)

Events

Posts

• {"post-page-view": {}}

• {"post-page-view-duration": {}}

• {"post-teaser-view": {}}

• {"post-teaser-click": {}}