Links
The Links resource has full CRUD functionality. It allows you to Create, Retrieve, Update, and Delete Links. The following actions can be performed on this resource...
Retrieve All Links
By default, the first set of 250 links will be returned, but you can modify this number with limit and offset values in the query string. The max limit for a single request is 10,000. You can also retrieve your data with pagination. You do this by passing the page and pageSize query string parameters. Page determines which page number to bring back and pageSize determines the number of links to bring back in that page.
When retrieving multiple Links, you may also want to include additional criteria in the query string to filter the results by. Any field that is included in the resources is available for use as a filter. These are exact matches; they are case-sensitive and do not allow wildcards.
Example Response:
{
"data": [
{
"link_id": 33,
"_brand_id": 3,
"_contact_id": null,
"name": "SlickText",
"url": "http://www.slicktext.com",
"type": "normal",
"source": "Campaign",
"_source_id": 56,
"sub_source": null,
"_sub_source_id": null,
"clicks": 4,
"unique_clicks": 1,
"bot_clicks": 0,
"active": 1,
"created": "2024-10-31 20:38:30",
"expires": null
}
]
}
Retrieve a Specific Link
Retrieves a single link with the Link ID equal to {id}.
Example Response:
{
"data": [
{
"link_id": 3333,
"_brand_id": 123456789,
"_contact_id": null,
"name": "SlickText",
"url": "http://www.slicktext.com",
"type": "normal",
"source": "Campaign",
"_source_id": 56,
"sub_source": null,
"_sub_source_id": null,
"clicks": 4,
"unique_clicks": 1,
"bot_clicks": 0,
"active": 1,
"created": "2024-10-31 20:38:30",
"expires": null
}
]
}
Edit a Specific Link
Allows you to edit existing Links. You can target an existing Link by passing the Link ID in your PUT request. At least one of the arguments below is required.
Arguments
| PARAMETER | DESCRIPTION |
|---|---|
| name | Name of the Link. |
| url | URL that you want to link to. |
| active | Indicate whether the Link is active (1 or 0). |
Example Request:
{
"link_id": 111,
"_brand_id": 123456789,
"_contact_id": null,
"name": "Updated Link Name",
"url": "http://dev.slicktext.com/",
"type": "normal",
"source": "manual",
"_source_id": null,
"sub_source": null,
"_sub_source_id": null,
"clicks": 0,
"unique_clicks": 0,
"bot_clicks": 0,
"active": 0,
"created": "2024-11-27 18:22:48",
"expires": null
}
Create a Link
Creates an empty link on this brand.
Arguments
| PARAMETER | DESCRIPTION |
|---|---|
| name (mandatory) | The name of the link you are creating. |
| url | URL that you want to link to. |
Example Request:
{
"_brand_id": 123456789,
"name": "SlickText",
"url": "http://wwww.slicktext.com",
"source": "manual",
"clicks": 0,
"unique_clicks": 0,
"bot_clicks": 0,
"active": 1,
"type": "normal",
"link_id": 111,
"created": "2024-12-23 21:42:38"
}
Delete a Specific Link
Deletes an existing link with the Link ID equal to {id}. Using this action, the link is simply removed completely from the brand. All revenue and click data associated with the link will also be deleted.
Example Response:
[]