Catalog

FieldInfo For Table

Get Field level info about a NodeType(user). Contains the possible values contained in each field.

get/api/schema/{table}/fieldinfo

Request

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

Path parameters

tablestring required

Table name (generally "user")

Query parameters

account_idstring

Your Lytics account ID.

limitinteger

number of unique values to return per field

fieldsstring

list, or comma separated list of string fields to include

Response

OK

Example response

{
  "data": {
    "fields": [
      {
        "field": "region",
        "terms_counts": {
          "02": 704,
          "07": 857,
          "AZ": 671,
          "CA": 18064,
          "CO": 654,
          "FL": 1537,
          "GA": 822,
          "H9": 758,
          "IL": 1254,
          "KS": 1104,
          "MA": 1301,
          "NC": 626,
          "NJ": 892,
          "NY": 4035,
          "ON": 1097,
          "OR": 12158,
          "PA": 1040,
          "TX": 2726,
          "VA": 1894,
          "WA": 1948
        },
        "more_terms": true,
        "ents_present": 70489,
        "ents_absent": 65796,
        "high_card": false,
        "approx_cardinality": 331
      },
      {
        "field": "utm_mediums",
        "terms_counts": {
          "Integrations-page": 1102,
          "adwords": 4434,
          "banner": 1496,
          "blog": 3413,
          "card": 10,
          "cpc": 2923,
          "email": 6051,
          "ppc": 220,
          "search": 8762,
          "social": 12513,
          "parnter": 2314
        },
        "more_terms": true,
        "ents_present": 29595,
        "ents_absent": 116690,
        "high_card": false,
        "approx_cardinality": 27
      },
      {
        "field": "zd_yymm",
        "terms_counts": {
          "1409": 5,
          "1410": 12,
          "1411": 4,
          "1412": 4,
          "1501": 3,
          "1502": 10,
          "1503": 26,
          "1504": 20,
          "1505": 3
        },
        "more_terms": false,
        "ents_present": 72,
        "ents_absent": 136213,
        "high_card": false,
        "approx_cardinality": 9
      },
      {
        "field": "openct",
        "terms_counts": {
          "1": 75,
          "2": 42,
          "3": 11,
          "4": 25,
          "5": 16,
          "6": 17,
          "8": 5,
          "9": 11,
          "10": 18,
          "11": 7,
          "12": 5,
          "19": 8,
          "20": 15,
          "24": 3,
          "26": 10,
          "32": 3,
          "35": 3,
          "51": 15,
          "108": 3,
          "152": 3
        },
        "more_terms": true,
        "ents_present": 328,
        "ents_absent": 135957,
        "high_card": false,
        "approx_cardinality": 98,
        "stats": {
          "mean": 15.621951219512194,
          "sd": 27.978602557504388,
          "min": 1,
          "max": 264,
          "n": 328
        }
      },
      {
        "field": "mc_lastopen_ts",
        "terms_counts": {},
        "more_terms": false,
        "histograms": [
          {
            "data": {
              "1446336000000": 2,
              "1446595200000": 2,
              "1447891200000": 333,
              "1448150400000": 348,
              "1448409600000": 9,
              "1448668800000": 8
            },
            "start": "1446401936511",
            "end": "1448993936511",
            "interval": "3d"
          },
          {
            "data": {
              "1442188800000": 35,
              "1442793600000": 3,
              "1445212800000": 71,
              "1445817600000": 2,
              "1446422400000": 4,
              "1447632000000": 340,
              "1448236800000": 351,
              "1448841600000": 7
            },
            "start": "1441131536511",
            "end": "1448993936511",
            "interval": "week"
          },
          {
            "data": {
              "1417392000000": 3,
              "1420070400000": 2,
              "1425168000000": 2,
              "1427846400000": 43,
              "1430438400000": 5,
              "1433116800000": 24,
              "1435708800000": 41,
              "1438387200000": 48,
              "1441065600000": 38,
              "1443657600000": 73,
              "1446336000000": 702
            },
            "start": "1417457936511",
            "end": "1448993936511",
            "interval": "month"
          }
        ],
        "ents_present": 1377,
        "ents_absent": 134908,
        "high_card": false,
        "approx_cardinality": 1212
      }
    ]
  }
}

Changes

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