Catalog

Schema Fields

Get Field information about a NodeType(user). Eventually, we will extend beyond user.

get/api/schema/{table}

Request

  • Base URL
    https://api.lytics.io
  • URL
    https://api.lytics.io/api/schema/{table}
  • Auth
    API key in header Authorization

Path parameters

tablestring required

Name

Query parameters

account_idstring

Your Lytics account ID.

Response

OK

Example response

{
  "data": {
    "fields": [
      {
        "as": "created_ts",
        "is_by": false,
        "type": "date",
        "shortdesc": "Created Date",
        "longdesc": "First time usage for this user",
        "froms": [
          "default"
        ],
        "identities": [
          "min"
        ]
      },
      {
        "as": "content",
        "is_by": false,
        "type": "string",
        "shortdesc": "Site Content",
        "longdesc": "Specific piece of content viewed",
        "froms": [
          "default"
        ],
        "identities": [
          "content"
        ]
      },
      {
        "as": "location",
        "is_by": false,
        "type": "string",
        "shortdesc": "Location",
        "longdesc": "",
        "froms": [
          "linkedin_data"
        ],
        "identities": [
          "location"
        ]
      }
    ]
  }
}

Changes

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