← Back to API Reference overview

Links

Endpoints for managing shortened links in Linkbreakers. These endpoints allow you to create, retrieve, list, and delete shortened links for your workspace.

Shortcut: ⌘K
GET/v1/links/{linkId}/lead-score-explanation/{eventId}Requires auth

#Get lead score explanation

Generates an AI-powered explanation for a lead score result based on event data.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

eventId

stringRequiredpath

The ID of the event for which to generate the explanation (UUID)

#Response

200

Everything worked as expected.

breakdown

object

Breakdown of lead scoring factors

explanation

string

Detailed explanation of how the lead score was calculated

leadScore

integer (int32)

The lead score that was calculated for this event

recurringScans

integer (int32)

Number of recurring scans from this device+link combination

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PATCH/v1/links/{linkId}/lead-score-feedback/{eventId}Requires auth

#Update lead score feedback

Updates the feedback score and comment for a lead scoring analysis.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

eventId

stringRequiredpath

The ID of the event for which to update feedback (UUID)

#Request body

feedbackComment

string

Optional feedback comment

feedbackScore

integer (int32)

Score from 0 to 10 rating the lead scoring accuracy

#Response

200

Everything worked as expected.

feedbackComment

string

Updated feedback comment

feedbackScore

integer (int32)

Updated feedback score

success

boolean

Success status

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.