Skip to main content

PeopleSearchPanel

One network's ranked panel. The order of results is the search core's and is never re-ranked by the platform.

okbooleanrequired
sourceSource (string)required

source social network of profile

Possible values: [ig, fb, tt, tw, li]

Default value: tw
tierintegerrequired

1 — has a pinned card; 2 — the top card matched two or more signals; 3 — non-empty; 4 — empty or failed.

Possible values: >= 1 and <= 4

totalinteger<int64>required
total_is_lower_boundboolean
Default value: false
results object[]required
  • Array [
  • imagestringrequired
    idProfileId (string)required

    id of profile

    usernamestringrequired
    fullnamestringrequired
    imageNotLoadedboolean
    sourceSource (string)required

    source social network of profile

    Possible values: [ig, fb, tt, tw, li]

    Default value: tw
    linkstringrequired
    badReasonProfileBadReason (string)

    followsPrivate means TikTok has hidden its following list; it does not imply that the account itself is private.

    Possible values: [unloaded, unmapped, zeroFollows, private, notFound, optOut, unexpected, followsPrivate]

    badReasonConfirmedboolean
    pinnedbooleanrequired

    Pinned to the top by an exact lookup (@handle, phone) or the identity graph.

    Default value: false
    pickedbooleanrequired

    The account the user picked in this network.

    Default value: false
    pin_rankintegernullable

    Order among the pinned cards (unique within a panel).

    panel_rankintegernullable

    Where the core's ranking had this card (null when it came from a lookup, not from retrieval).

    matchedstring[]required

    Which fields of the query this card matched — NAMES ONLY, never values: name, place, bio, work, interests, gender, age, language, friends (the place or the interests of the people they follow — not their own), phone, handle. This is the whole of what a card may say about why it is here; the client renders each name from its own closed dictionary and drops a name it does not know. A masked (phone-lookup) card carries an empty array.

    confidencestring

    How sure the identity graph is that this account belongs to the same person, when it is the graph that put the card in this panel: one of CONFIRMED, SURE, STRONG — the graph's own bands, the only three that make an account a pin. Absent on every other card. It is a BAND, never a number: it is not a threshold on a probability and must not be rendered as one, and no percent is computed anywhere. WHY the graph is sure — which pick, on what evidence, how crowded the decision was — is not sent.

    seed_originboolean

    The account this seeded search started from ("find other their accounts").

    linked_to object

    A phone mask search's PERSON: on a card of another network's panel, the Instagram account of the same person — a card of this report's Instagram panel, by the report's own id. One person is that Instagram card plus every card whose linked_to names it; the client draws them as one row and ticks them together. Only the identity graph's certain partners get one (the pins' rule), at most one per network per person. An exception (with lifted_by) to "no pointer to where a card came from" above: it says WHOSE account this is, never why or how sure. Absent on every other card.

    sourceSource (string)required

    source social network of profile

    Possible values: [ig, fb, tt, tw, li]

    Default value: tw
    idProfileId (string)required

    id of profile

    lifted_by object

    The card was LIFTED by a LinkedIn hit (PeopleSearchLiftedBy) — like linked_to, an exception to "no pointer to where a card came from": it names the network and the typed facts, never the LinkedIn profile, why or how sure. Kept with the stored panels, so a restore shows it again. Absent on every other card, a pinned card included (a pin is never re-marked as lifted).

    sourceSource (string)required

    The network of the hit that lifted the card — li.

    Possible values: [ig, fb, tt, tw, li]

    Default value: tw
    signalsstring[]required

    The typed facts the LinkedIn hit matched — names from matched's closed vocabulary: work, place. The client drops a name it does not know.

  • ]
  • pins object[]required
  • Array [
  • idProfileId (string)required

    id of profile

    in_indexbooleanrequired

    False when the partner is not among that network's search results — it is listed, not shown as a card.

  • ]
  • question object

    The one refinement question the core suggests for this panel (the ladder).

    kindstringrequired

    state, country, state_pick, topic, language, gender, …

    questionstringrequired
    options object[]required
  • Array [
  • valuestringnullable

    null = the "not sure" option.

    labelstringrequired
  • ]
  • degradedstring[]

    Channels that failed while building this panel; the ranking is not comparable with a healthy one.

    error_codestring

    Set when the network could not be searched: unsupported_network, unsupported_fields, gateway_unavailable (the search service answered nothing for this network), or a short code naming how the search failed. No free-text message is returned.

    basicbooleanrequired

    True when this panel came from the legacy search template (no matched, no pins, no question).

    blurredboolean

    Same contract as ProfilesPage.blurred — every card is masked behind the phone-search paywall. On a phone mask search (PeopleSearchState.phone_mask.searched) a card's fullname keeps the words of the name the user typed (its first three words) as they are written in the account's name, and every other word is its first letter followed by *** — never its length; username and link are empty; image is the blurred avatar. On a phone-origin report a masked card's id is the report's own: it names the account in this report's picks and confirm only, and is not the id the same account has anywhere else.

    Default value: false
    took_msinteger
    stagePeopleSearchStage (string)

    quick — a first look (PeopleSearchStage): shown until the full answer of this network replaces it; total is its own card count. Absent — the answer.

    Possible values: [quick, full]

    Default value: full
    leadstring

    A phone mask search's verdict, on its Instagram panel: one — the number most likely belongs to the one person of results (the only account carrying every typed word of the name, 10 % ahead of every other); few — up to three people could be them (the page asks for their city to narrow it down); none — nobody in the pool carries the typed name, results is empty. Absent on every other panel.

    Possible values: [one, few, none]

    default_sortstring

    Which of the two card orders this panel should OPEN on, as the search core decided it from the query: panel — the order of results (the name spine; a name of two or more words); signals — by the number of matched signals (matched), a one-word name, where every card matches the name completely and only the evidence tells them apart. A hint for the initial sort only: both orders stay available, and results keeps the core's order either way. Absent — an older search service, a failed panel, or a value the platform does not know; open on panel. Kept with the stored panels, so a restore opens on the same order.

    Possible values: [panel, signals]

    PeopleSearchPanel
    {
    "ok": true,
    "source": "tw",
    "tier": 0,
    "total": 0,
    "total_is_lower_bound": false,
    "results": [
    {
    "image": "string",
    "id": "string",
    "username": "string",
    "fullname": "string",
    "imageNotLoaded": true,
    "source": "tw",
    "link": "string",
    "badReason": "unloaded",
    "badReasonConfirmed": true,
    "pinned": false,
    "picked": false,
    "pin_rank": 0,
    "panel_rank": 0,
    "matched": [
    "string"
    ],
    "confidence": "string",
    "seed_origin": true,
    "linked_to": {
    "source": "tw",
    "id": "string"
    },
    "lifted_by": {
    "source": "tw",
    "signals": [
    "string"
    ]
    }
    }
    ],
    "pins": [
    {
    "id": "string",
    "in_index": true
    }
    ],
    "question": {
    "kind": "string",
    "question": "string",
    "options": [
    {
    "value": "string",
    "label": "string"
    }
    ]
    },
    "degraded": [
    "string"
    ],
    "error_code": "string",
    "basic": true,
    "blurred": false,
    "took_ms": 0,
    "stage": "full",
    "lead": "one",
    "default_sort": "panel"
    }