Catalog

Field Hide

This POST endpoint allows specific fields belong to a stream to be hidden/un-hidden. A hidden field is not visible from the Application Data > Streams Web UI.

CAVEAT'S

  • This does not delete the data, only hides the field in the UI.

  • If queries (LQL) stil map this field into profiles, it will still be added

# Hide the 'first-name' field from the 'default' stream
curl -XPUT 'https://api.lytics.io/api/schema/_streams/default' \
    -H 'Content-type: application/json'
    -H 'Authorization: $LIOKEY' \
    -d '{
        "name": "first_name",
        "hidden": true
    }' | jq '.'
post/api/schema/_streams/{stream},{name},{hidden}

Request

  • Base URL
    https://api.lytics.io
  • URL
    https://api.lytics.io/api/schema/_streams/{stream},{name},{hidden}
  • Auth
    API key in header Authorization

Path parameters

streamstring required

Name of the stream containing the field to delete

namestring required

Name of the field to delete

hiddenboolean required

hide field from Web UI

Query parameters

account_idstring

Your Lytics account ID.

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.