|
Sample URI: |
https://linksearch.api.cj.com/v2/link-search?website-id=12345678&keywords=%2Bsony+-camera |
The Link Search Service is a REST API that enables developers to find links in the Commission Junction network based on desired criteria. Developers may search for links by any number of criteria including keywords, country, category, targeted area, relationship status (with the advertiser), link size or link type.
Commission Junction's REST Web Services use the standard HTTP Authorization header to pass authentication information. You must provide your developer key to pass authentication. The request URI for the Publisher Lookup Service API must be properly encoded based on HTML 4 specification form content encoding rules. Please refer to http://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13.4 for the standard specification.
Note: Some languages may have built-in utility methods for encoding URIs based on RFC 1738. Unfortunately, these utility methods may not properly encode white space character and "+" character. Specifically, white space character should be encoded to "+" character, and "+" character should be encoded to "%2B".
Click the following links to display more specific information regarding the Link Search Service in REST.
Refer to the following table for a list of the request parameters. All parameter names and values are case insensitive.
Important: You must provide at least one of the optional parameters. Submitting an empty request does not return all possible results; an empty request returns zero results.
|
Header |
Description |
|
authorization |
Your developer key obtained from the Web Services Developer Site. |
|
Parameter Name |
Description |
|
advertiser-id |
Limits the results to a set of particular advertisers (CIDs) using one of the following four values.
Note: Empty String for advertiser-ids is currently behaving the same as using the non-joined value. We will correct this in a future release.
|
|
category |
Limits the results to links in a specific sub-category. You may obtain a list of available categories using the Support Services. Important: The system does not support searching top-level categories. You must choose a specific sub-category in which to search. For example, if you want links for medical equipment, you must use Equipment (the sub-category) as the value of the category parameter. Tip: Use a combination of sub-category and keyword to obtain more precise search results. For example, to find links for medical equipment, try Equipment (the sub-category) as the value of the category parameter and Medical as the value of the keyword parameter. |
|
link-type |
Limits the results to links of a specific link type. You may obtain a list of available link types using the Support Services. |
|
promotion-type |
Limits the results to link of the specified promotion type. You must specify a value for this parameter is you use the start-date or end-date parameters. Acceptable values include the following.
|
|
promotion-start-date |
Specifies the start date of the associated promotion. You must enter dates in the MM/DD/YYYY format. Leaving this field blank returns promotions with any start date. |
|
promotion-end-date |
Specifies the end date of the associated promotion. You must enter dates in the MM/DD/YYYY format, or enter the value ongoing to specify a promotion with no end date. Leaving this field blank returns promotions with any end date. |
|
page-number |
Specifies the page of the results set that is currently being viewed. |
|
records-per-page |
Specifies the number of records to be viewed per page. |
For more information, refer to the forums at the Web Services Developer Site (http://webservices.cj.com).
The response includes information about the general response, as well as specific information for each record in the response. All parameter names and values are case insensitive.
The response includes the following information about the overall set of results in the response.
|
Field Name |
Description |
|
links |
An array of link records. See the Per Record (Link) table for the fields returned for each link record in the response. |
|
total-results |
The total number of matching results in the index, regardless of the number of results in the actual response (the value of the max-results parameter). |
The response includes the following fields for each record (i.e., link).
|
Field Name |
Description |
|
advertiser-id |
The advertiser's CID. |
|
click-commission |
The commission per click offered by the advertiser. |
|
creative-height |
The height (in pixels) of the link. |
|
creative-width |
The width (in pixels) of the link. |
|
lead-commission |
The commission per lead offered by the advertiser. |
|
link-code-html |
The link code (in HTML). Note: This field is blank for advertisers with which you do not have a relationship (non-joined). |
|
link-code-javascript |
The link code (in JavaScript). Note: This field is blank for advertisers with which you do not have a relationship (non-joined). Note: This field is blank for advanced links. |
|
link-destination |
The link's destination URL. |
|
link-description |
The link's description. |
|
link-id |
The link ID. |
|
link-name |
The link name. |
|
link-type |
The link type. |
|
advertiser-name |
The advertisers name. |
|
performance-incentives |
Whether or not the advertiser offers performance incentives. This value is Yes if they do, or No if they do not offer incentives. |
|
promotion-type |
The associated promotion type. |
|
promotion-start-date |
The associated promotion start date. |
|
promotion-end-date |
The associated promotion end date. |
|
relationship-status |
The advertisers relationship status with a publisher. This value can be either joined or not-joined. |
|
sale-commission |
The commission per sale offered by the advertiser. |
|
seven-day-epc |
The link's 7-day EPC. |
|
three-month-epc |
The link's 3-month EPC. |
|
Error |
Description |
|
Not Authenticated |
The system could not authenticate your developer key. |