Record profile view

POST

https://api.sureshake.com/v2/directory/{subjectType}/{slug}/profile-views

Authorization

BearerAuth
optional
HTTP

Path parameters

subjectType
person
or
entity
required
slug
string
required
maxLength: 255 · minLength: 1

Request body JSON required

operationId
string
required
format: uuid
source
optional
string
maxLength: 100 · minLength: 1 · default: "direct"
preview
optional
boolean
default: false

Returns

200

Default Response

JSON

data
object
required
- recorded
  boolean
  required
- deduplicated
  boolean
  required
- policyExcluded
  boolean
  required
- exclusionReason
  self_or_manager
  or
  active_block
  or
  excluded_traffic
  or
  preview
  or null
  required
- eventId
  string
  or null
  required
  format: uuid
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Record profile view

curl --request POST \
  --url 'https://api.sureshake.com/v2/directory/person/<slug>/profile-views' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  "source": "direct",
  "preview": false
}
'

const url = 'https://api.sureshake.com/v2/directory/person/<slug>/profile-views';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    operationId: '3051932a-fdd2-48fa-b330-7e7d41535969',
    source: 'direct',
    preview: false
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/directory/person/<slug>/profile-views"

payload = {
    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
    "source": "direct",
    "preview": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "recorded": true,
    "deduplicated": true,
    "policyExcluded": true,
    "exclusionReason": "self_or_manager",
    "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}