:orphan:

.. role:: json(code)
   :language: json

.. role:: python(code)
   :language: python


Taxonomy
========

.. contents:: :depth: 3

.. _taxonomy-filters:

Filters
#######

- Include only records that match any of the labels
    .. code:: json

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

- Exclude all records that match any of the labels
    .. code:: json

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

- Include only records that match any of the ranges
    .. code:: json

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

- Exclude all records that match any of the ranges
    .. code:: json

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


Hints:

- <label> (see: `Labels`_)
- <range> (see: `Ranges`_)
- <field> (see: `Fields`_)


.. _taxonomy-labels:

Labels
######

Entity Label is a concept ...

- Match by a badge field (e.g. when :python:`Post.is_private` is True)
    :json:`{"badge": {"field": <field>}}`
- Match by an empty field (e.g. when :python:`Post.sections` is empty)
    :json:`{"empty": {"field": <field>}}`
- Match by a field value (e.g. when `value` in :python:`Post.sections`)
    :json:`{"value": {"field": <field>, "value": <scalar>}}`


Hints:

- <field> (see: `Fields`_)


.. _taxonomy-ranges:

Ranges
######

Entity Range is a concept ...

- Match by a field value more than `min`
    :json:`{"field": <field>, "min": <scalar>}`
- Match by a field value less than `max`
    :json:`{"field": <field>, "max": <scalar>}`
- Match by a field value in a range between `min` and `max`
    :json:`{"field": <field>, "min": <scalar>, "max": <scalar>}`

Hints:

- <field> (see: `Fields`_)


.. _taxonomy-entities:

Entities
########

.. _taxonomy-entity-types:

Types
-----

- :json:`{"post": {}}` -- a post entity type
- :json:`{"user": {}}` -- a user profile entity type

.. _taxonomy-entity-guids:

GUIDs
-----

- :json:`{"post": {"id": 12345}}` -- a post entity
- :json:`{"user": {"id": 34567}}` -- a user profile entity

.. _taxonomy-entity-fields:

Fields
------

Posts
~~~~~

- :json:`{"post-id": {}}` -- post ID (1..1)
- :json:`{"post-type": {}}` -- post type (1..1)

  - `"page"`
  - `"image"`
  - `"video"`
  - `"event"`
  - `"place"`
  - `"how-to"`
  - `"recipe"`
  - `"product"`

- :json:`{"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"`

- :json:`{"post-is-private": {}}` -- post privacy (0..1)
- :json:`{"post-is-suspicious": {}}` -- post suspicious flag (0..1)
- :json:`{"post-is-excluded-from-search": {}}` -- post search visibility (0..1)
- :json:`{"post-modified-at": {}}` -- post last modification timestamp (1..1)
- :json:`{"post-scheduled-at": {}}` -- post scheduled timestamp (0..1)
- :json:`{"post-published-at": {}}` -- post published timestamp (0..1)
- :json:`{"post-embargoed-until": {}}` -- post embargo timestamp (0..1)
- :json:`{"post-title": {}}` -- post headline (1..1)
- :json:`{"post-subtitle": {}}` -- a list of post sub-headlines including `subheadline`, twitter text, and every particle `headline` and `headline_html` (0..*)
- :json:`{"post-bodies": {}}` -- a list of post bodies including `body` and every particle `body` (0..*)
- :json:`{"post-primary-tag": {}}` -- the primary tag slug (0..1)
- :json:`{"post-regular-tag": {}}` -- a regular tag slug (0..*)
- :json:`{"post-primary-section": {}}` -- the primary section ID (0..1)
- :json:`{"post-regular-section": {}}` -- a regular section ID (0..*)
- :json:`{"post-community": {}}` -- the community ID (0..1)
- :json:`{"post-author": {}}` -- an author ID (1..*)
- :json:`{"post-stage": {}}` -- the stage ID (0..1)
- :json:`{"post-page-layout": {}}` -- the post page custom layout slug (0..1)
- :json:`{"post-editor-layout": {}}` -- the post editor custom layout slug (0..1)
- :json:`{"post-custom-field": {"path": "path.to.field"}}` -- a custom field value (0..*)

User Profiles
~~~~~~~~~~~~~

- :json:`{"user-id": {}}` -- user profile ID (1..1)
- :json:`{"user-email": {}}` -- user email (0..*)
- :json:`{"user-profile-slug": {}}` -- user profile slug (1..1)
- :json:`{"user-profile-title": {}}` -- user profile title (1..1)
- :json:`{"user-profile-owner": {}}` -- user ID (1..1)
- :json:`{"user-profile-status": {}}` -- user profile status (1..1)

  - `"active"`
  - `"pending"`
  - `"inactive(banned=true)"`
  - `"inactive(banned=false)"`

- :json:`{"user-profile-created-at": {}}` -- user profile creation timestamp (1..1)
- :json:`{"user-profile-about-html": {}}` -- user profile about HTML (1..1)
- :json:`{"user-profile-description": {}}` -- user profile about HTML (1..1)
- :json:`{"user-group": {}}` -- user group slug (0..*)
- :json:`{"user-community": {}}` -- user community ID (0..*)
- :json:`{"user-access-role": {}}` -- user access role ID (0..*)
- :json:`{"user-last-logged-in-at": {}}` -- user last logged in timestamp (1..1)
- :json:`{"user-custom-field": {"path": "path.to.field"}}` -- a custom field value (0..*)

Sections
~~~~~~~~

- :json:`{"section-id": {}}` -- section ID (1..1)
- :json:`{"section-parent": {}}` -- parent section ID (0..1)
- :json:`{"section-ancestor": {}}` -- ancestor section ID (0..*)

.. _taxonomy-entity-events:

Events
------

Posts
~~~~~

- :json:`{"post-page-view": {}}`
- :json:`{"post-page-view-duration": {}}`
- :json:`{"post-teaser-view": {}}`
- :json:`{"post-teaser-click": {}}`