API Reference - Users Clicked Link

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108048

← Back to API Reference | Getting Started

Users Clicked Links

Tracks link clicks and interactions on member profiles and listings. Each record represents a single click event.

Model name in URL: users_clicks — DB table: users_clicks

The Users Clicked Link Object

FieldTypeDescription
click_idintegerUnique click ID (primary key, read-only)
user_idintegerID of the member profile that was clicked
click_typestringType of click (e.g. link, phone, email)
click_namestringName/label of the clicked element
click_fromstringPage where the click originated (e.g. profile_page, search_results)
click_urltextFull URL that was clicked
click_ipstringVisitor's IP address
visitor_tokenstringUnique token identifying the visitor session
click_tokenstringUnique token for this click event
date_clickedstringClick timestamp (format: YYYYMMDDHHmmss)
post_idintegerRelated post ID if click was on a listing or post
is_single_postinteger1 if post_id is a single post; 0 if an album group

List Users Clicked Links

GET /api/v2/users_clicks/get
Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_clicks/get?property=user_id&property_value=42" \
  -H "X-Api-Key: your-api-key-here"

Retrieve a Click Record

GET /api/v2/users_clicks/get/{click_id}
Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_clicks/get/1005" \
  -H "X-Api-Key: your-api-key-here"

Create a Click Record

POST /api/v2/users_clicks/create
Copy
curl -X POST "https://www.yourdomain.com/api/v2/users_clicks/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "user_id=42" \
  -d "click_type=link" \
  -d "click_name=Website" \
  -d "click_from=profile_page" \
  -d "click_url=https%3A%2F%2Fwww.example.com"

Update a Click Record

PUT /api/v2/users_clicks/update
Copy
curl -X PUT "https://www.yourdomain.com/api/v2/users_clicks/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "click_id=1005" \
  -d "click_name=Updated+Name"

Delete a Click Record

DELETE /api/v2/users_clicks/delete
Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/users_clicks/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "click_id=1005"

Search Click Records

POST /api/v2/users_clicks/search
The search endpoint is not currently available for this model.