Query Journeys - Fabric Docs

Query Journeys

curl --request GET \
  --url https://api.onfabric.io/api/v1/journey/{user_id}

[
  {
    "id": "<string>",
    "text": "<string>",
    "topics": [
      "<string>"
    ],
    "entities": [
      "<string>"
    ],
    "traits": {
      "sex": {
        "value": "MALE",
        "confidence": "NONE"
      },
      "country": {
        "value": "ABW",
        "confidence": "NONE"
      },
      "affluence": {
        "value": "LOW",
        "confidence": "NONE"
      },
      "political_affiliation": {
        "value": "LEFT",
        "confidence": "NONE"
      },
      "age": {
        "value": "0-18+",
        "confidence": "NONE"
      }
    },
    "cohesion": 123,
    "count": 123,
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  }
]

GET

/

journey

/

{user_id}

Query Journeys

curl --request GET \
  --url https://api.onfabric.io/api/v1/journey/{user_id}

[
  {
    "id": "<string>",
    "text": "<string>",
    "topics": [
      "<string>"
    ],
    "entities": [
      "<string>"
    ],
    "traits": {
      "sex": {
        "value": "MALE",
        "confidence": "NONE"
      },
      "country": {
        "value": "ABW",
        "confidence": "NONE"
      },
      "affluence": {
        "value": "LOW",
        "confidence": "NONE"
      },
      "political_affiliation": {
        "value": "LEFT",
        "confidence": "NONE"
      },
      "age": {
        "value": "0-18+",
        "confidence": "NONE"
      }
    },
    "cohesion": 123,
    "count": 123,
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  }
]

Headers

api-key

string

The api key generated from the Fabric developer portal

Path Parameters

user_id

string

required

Query Parameters

top_k

integer

required

Number of results to return

query

string | null

Search string to filter events

from_date

string<date-time>

Start date to filter events from

to_date

string<date-time>

End date to filter events to

Response

Successful Response

id

string<uuid4>

required

text

string

required

topics

string[]

required

entities

string[]

required

traits

Traits · object

required

Show child attributes

traits.sex

SexTrait · object

required

Show child attributes

traits.sex.value

enum<string> | null

required

Available options:

MALE,

FEMALE,

OTHER

traits.sex.confidence

enum<string>

required

Available options:

NONE,

LOW,

MEDIUM,

HIGH

traits.country

CountryTrait · object

required

Show child attributes

traits.country.value

enum<string> | null

required

Available options:

ABW,

AFG,

AGO,

AIA,

ALA,

ALB,

AND,

ARE,

ARG,

ARM,

ASM,

ATA,

ATF,

ATG,

AUS,

AUT,

AZE,

BDI,

BEL,

BEN,

BES,

BFA,

BGD,

BGR,

BHR,

BHS,

BIH,

BLM,

BLR,

BLZ,

BMU,

BOL,

BRA,

BRB,

BRN,

BTN,

BVT,

BWA,

CAF,

CAN,

CCK,

CHE,

CHL,

CHN,

CIV,

CMR,

COD,

COG,

COK,

COL,

COM,

CPV,

CRI,

CUB,

CUW,

CXR,

CYM,

CYP,

CZE,

DEU,

DJI,

DMA,

DNK,

DOM,

DZA,

ECU,

EGY,

ERI,

ESH,

ESP,

EST,

ETH,

FIN,

FJI,

FLK,

FRA,

FRO,

FSM,

GAB,

GBR,

GEO,

GGY,

GHA,

GIB,

GIN,

GLP,

GMB,

GNB,

GNQ,

GRC,

GRD,

GRL,

GTM,

GUF,

GUM,

GUY,

HKG,

HMD,

HND,

HRV,

HTI,

HUN,

IDN,

IMN,

IND,

IOT,

IRL,

IRN,

IRQ,

ISL,

ISR,

ITA,

JAM,

JEY,

JOR,

JPN,

KAZ,

KEN,

KGZ,

KHM,

KIR,

KNA,

KOR,

KWT,

LAO,

LBN,

LBR,

LBY,

LCA,

LIE,

LKA,

LSO,

LTU,

LUX,

LVA,

MAC,

MAF,

MAR,

MCO,

MDA,

MDG,

MDV,

MEX,

MHL,

MKD,

MLI,

MLT,

MMR,

MNE,

MNG,

MNP,

MOZ,

MRT,

MSR,

MTQ,

MUS,

MWI,

MYS,

MYT,

NAM,

NCL,

NER,

NFK,

NGA,

NIC,

NIU,

NLD,

NOR,

NPL,

NRU,

NZL,

OMN,

PAK,

PAN,

PCN,

PER,

PHL,

PLW,

PNG,

POL,

PRI,

PRK,

PRT,

PRY,

PSE,

PYF,

QAT,

REU,

ROU,

RUS,

RWA,

SAU,

SDN,

SEN,

SGP,

SGS,

SHN,

SJM,

SLB,

SLE,

SLV,

SMR,

SOM,

SPM,

SRB,

SSD,

STP,

SUR,

SVK,

SVN,

SWE,

SWZ,

SXM,

SYC,

SYR,

TCA,

TCD,

TGO,

THA,

TJK,

TKL,

TKM,

TLS,

TON,

TTO,

TUN,

TUR,

TUV,

TWN,

TZA,

UGA,

UKR,

UMI,

URY,

USA,

UZB,

VAT,

VCT,

VEN,

VGB,

VIR,

VNM,

VUT,

WLF,

WSM,

YEM,

ZAF,

ZMB,

ZWE

traits.country.confidence

enum<string>

required

Available options:

NONE,

LOW,

MEDIUM,

HIGH

traits.affluence

AffluenceTrait · object

required

Show child attributes

traits.affluence.value

enum<string> | null

required

Available options:

LOW,

MIDDLE,

UPPER

traits.affluence.confidence

enum<string>

required

Available options:

NONE,

LOW,

MEDIUM,

HIGH

traits.political_affiliation

PoliticalAffiliationTrait · object

required

Show child attributes

traits.political_affiliation.value

enum<string> | null

required

Available options:

LEFT,

RIGHT

traits.political_affiliation.confidence

enum<string>

required

Available options:

NONE,

LOW,

MEDIUM,

HIGH

traits.age

AgeTrait · object

required

Show child attributes

traits.age.value

enum<string> | null

required

Available options:

0-18+,

18-25+,

25-35+,

35-45+,

45-55+,

55+

traits.age.confidence

enum<string>

required

Available options:

NONE,

LOW,

MEDIUM,

HIGH

cohesion

number | null

required

count

integer

required

start_time

string<date-time>

required

end_time

string<date-time>

required

Ask User Get Journeys Overtime

⌘I