Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

In a nutshell

The Reverse Article Search Match API

The data that is being built up can be viewed via apps, reports, dashboards and the API’s. This support page is exclusively about the Reverse Article Search Match API, which we further call the API.

The API gives you access to all data built up from the beginning of your license. This way you can view information that cannot be viewed via the app, which shows data for the last 365 days.

With the parameters at your disposal you can request very specific information, as often as you want.

Because the API works with a larger database than the APP, the call may take a little longer, and the most recent data (1 day) is not processed.

Access

You have access to the API if you have the Id of your account and the Key of the API. You can find this on the profile page in the app, assuming that an API has been created by Matchhamster. If you don’t have one yet, but you want to, send us a ticket.

The endpoint of the API is: https://app.matchhamster.com/rest/match?

If your ID was 123 and your KEY is 8c5qwwcw3yym71f7, the url would look like this: https://app.matchhamster.com/rest/match?&id=123&key=8c5qwwcw3yym71f7

Security

The Key is shared with all users who have a login to the app. View the information on the profile page (that’s the page with your name). The Key will be changed at your administrators request.

Parameters

Parameters are options you can pass with the endpoint to influence the response.
You can for example look for a daterange, feed, country or article, or a combination of these parameters. Below you find all the options available for the API.

Parameters Value Availibility Description
id id Required Your account Id (3 to 5 digits) is provIded by us.
key string Required The Key (16 letters and numbers) is provIded by us. The Key only known by the people in your Organization using the APP. the key is shown on the profile page (with your name).
alertcopyid id Optional The unique Id of an Alert. You can see the Id in the APP in the URL, when you view an Alert.
datefrom date Optional The start date (dd-mm-yyyy).
dateto date Optional The end date (dd-mm-yyyy).
interval select Optional A selection from the current date. Options are: 1day, 2day, 3day, 4day, week, month. Do not use in combination with datefrom and dateto.
alertcountryid id Optional The unique Id of a Country. Check te list later on this page. You can alternatively use the parameter ‘alertdomaininfocountry’.
alertchannelnid You can see the Id of the cannel in the APP in the URL when you view a specific domain.
alertfeedid id Optional The unique Id of a Feed. A Feed could also be a newswire, publication or other source.The feeds and their Ids can be viewed in the APP on your profile tab (the tab with your name on it). Alternatively you can use the parameter ‘alertfeedinfotitle’.
alertwordsmatchedpercentage number Optional This value represents the minimum match-percentage (between 10-100). Only alerts with a similar or higher percentage will be shown.
alertwordsmatchedcategory string Optional The string from which can be derived based on which match-aspects the original Article and Alert are similar. An explanation of match aspects can be found in the support section at ‘About Matching and Alerts’
alertwordsmatchedamount number Optional The number of words that APPear in both the original Article and the Alert. The Alerts The alerts that comply with the entered value and anything greater are selected.
alertchannelcategory select Optional The Category to which the Domain belongs according to your Organization. Options are: Clients, Non Clients, Prospects, Infringers, Pending.
alertdomainhostname url Optional The Domain where the Alert is located.
alerttextid id Optional The unique Article Id. You can see the Article Id in the url when you select the Article in the APP.
alertfeedinfotitle string Optional The name of the Feed. A Feed could also be a newswire, publication or other source.
alerttexttitle string Optional The title of the original Article.
alerttextidstring string Optional The Id of the Article as provIded by you. With this Id you can normally find the Article in your systems.
alerttextcategory select Optional The most relevant IPTC category attached to the Article.That information may have been provIded by your organization or it may have been generated by Matchhamster.
alertdomaininfocountry select Optional The name of the Country where the Domain is maintained.
alertdomaininfocontinent select Optional The name of the Continent to which the Country belongs.
alertdomaininforegion select Optional The name of the socio-economic Region to which the Country belongs.
search string Optional With this parameter you can enter (part of) a Domain.
limit number Optional The number of records you want the API to return. The maximum number of records is 20.000.

Response elements

The response you get is in JSON format.

Response elements Value Description
alertcopyid id The unique Id of an Alert. You can see the Id in the APP in the URL, when you view an Alert.
textpublicationdate date The publication date of the Article as communicated to us by your organization.
accountid id The Id of your Account.
alertcountryid id The unique Id of a Country. Check te list later on this page. You can alternatively use the parameter ‘alertdomaininfocountry’.
alertdomainid id The unique Id of a Domain.
alertchanneld id You can see the Id of the cannel in the APP in the URL when you view a specific domain.
alertfeedid id The unique Id of a Feed. A Feed could also be a newswire, publication or other source.The feeds and their Ids can be viewed in the APP on your profile tab (the tab with your name on it). Alternatively you check out alertfeedinfotitle.
alertwordsmatchedpercentage number The similarity in words expressed as a percentage between the original Article and the Alert.
alertwordsmatchedcategory string The string from which can be derived based on which match-aspects the original Article and Alert are similar. An explanation of match aspects can be found in the support section at ‘About Matching and Alerts’
alertwordsmatchedamount number The number of words that appear in both the original Article and the Alert.
alertchannelcategory string The Category to which the Domain belongs according to your Organization. Options are: Clients, Non Clients, Prospects, Infringers, Pending.
alertdomainhostname string The domain where the Alert is located.
alerttextid id The unique Article Id. You can see the Article Id in the url when you select the Article in the APP.
alertcopyurl url The URL where the Alert was found when the snapshot was taken.
alertcopytitle string The title used on the URL for the Article.
alertfeedinfotitle string The name of the Feed. A Feed could also be a newswire, publication or other source.
alerttexttitle string The title of the original Article.
alerttextidstring string The Id of the Article as provIded by you. With this Id you can normally find the Article in your systems.
alerttextcategory string The most relevant IPTC category attached to the Article.That information may have been provIded by your organization or it may have been generated by Matchhamster.
alertdomaininfocountry string The name of the Country where the Domain is maintained.
alertdomaininfocontinent string The name of the Continent to which the Country belongs.
alertdomaininforegion string The name of the socio-economic Region to which the Country belongs.

 

IPTC

alerttextcategory iptc group
ART Arts, culture and entertainment
CRI Crime, law and justice
DIS Disaster and accident
ECO Economy, business and finance
EDU Education
ENV Environmental issue
HEA Health
HUM Human interest
LAB Labour
LIF Lifestyle and leisure
POL Politics
REL Religion and belief
SCI Science and technology
SOC Social issue
SPO Sport
UNR Unrest, conflicts and war
WEA Weather

Country

alertcountryid alertdomaininfocountry
3 Afghanistan
6 Albania
59 Algeria
12 American Samoa
1 Andorra
9 Angola
5 Anguilla
10 Antarctica
4 Antigua and Barbuda
11 Argentina
7 Armenia
15 Aruba
14 Australia
13 Austria
16 Azerbaijan
30 Bahamas
23 Bahrain
19 Bangladesh
18 Barbados
34 Belarus
20 Belgium
35 Belize
25 Benin
26 Bermuda
31 Bhutan
28 Bolivia
17 Bosnia and Herzegovina
33 Botswana
32 Bouvet Island
29 Brazil
104 British Indian Ocean Territory
234 British Virgin Islands
27 Brunei
22 Bulgaria
21 Burkina Faso
24 Burundi
115 Cambodia
45 Cameroon
36 Canada
50 Cape Verde
122 Cayman Islands
39 Central African Republic
210 Chad
44 Chile
46 China
51 Christmas Island
37 Cocos Islands
47 Colombia
117 Comoros
38 Congo [DRC]
40 Congo [Republic]
43 Cook Islands
48 Costa Rica
42 Côte Ivoire
246 Country n/a
247 country n/a Arabic
96 Croatia
49 Cuba
52 Cyprus
53 Czech Republic
56 Denmark
55 Djibouti
57 Dominica
58 Dominican Republic
60 Ecuador
62 Egypt
206 El Salvador
85 Equatorial Guinea
64 Eritrea
61 Estonia
66 Ethiopia
69 Falkland Islands
71 Faroe Islands
68 Fiji
67 Finland
72 France
77 French Guiana
172 French Polynesia
211 French Southern Territories
73 Gabon
82 Gambia
92 Gaza Strip
76 Georgia
54 Germany
79 Ghana
80 Gibraltar
86 Greece
81 Greenland
75 Grenada
84 Guadeloupe
89 Guam
88 Guatemala
78 Guernsey
83 Guinea
90 Guinea-Bissau
91 Guyana
97 Haiti
94 Heard Island and McDonald Islands
95 Honduras
93 Hong Kong
98 Hungary
107 Iceland
103 India
99 Indonesia
106 Iran
105 Iraq
100 Ireland
102 Isle of Man
101 Israel
108 Italy
110 Jamaica
112 Japan
109 Jersey
111 Jordan
123 Kazakhstan
113 Kenya
116 Kiribati
240 Kosovo
121 Kuwait
114 Kyrgyzstan
124 Laos
133 Latvia
125 Lebanon
130 Lesotho
129 Liberia
134 Libya
127 Liechtenstein
131 Lithuania
132 Luxembourg
145 Macau
141 Macedonia
139 Madagascar
153 Malawi
155 Malaysia
152 Maldives
142 Mali
150 Malta
140 Marshall Islands
147 Martinique
148 Mauritania
151 Mauritius
242 Mayotte
154 Mexico
70 Micronesia
137 Moldova
136 Monaco
144 Mongolia
138 Montenegro
149 Montserrat
135 Morocco
156 Mozambique
143 Myanmar [Burma]
157 Namibia
166 Nauru
165 Nepal
163 Netherlands
8 Netherlands Antilles
158 New Caledonia
168 New Zealand
162 Nicaragua
159 Niger
161 Nigeria
167 Niue
160 Norfolk Island
119 North Korea
146 Northern Mariana Islands
164 Norway
169 Oman
175 Pakistan
182 Palau
180 Palestinian Territories
170 Panama
173 Papua New Guinea
183 Paraguay
171 Peru
174 Philippines
178 Pitcairn Islands
176 Poland
181 Portugal
179 Puerto Rico
184 Qatar
185 Réunion
186 Romania
188 Russia
189 Rwanda
196 Saint Helena
118 Saint Kitts and Nevis
126 Saint Lucia
177 Saint Pierre and Miquelon
232 Saint Vincent and the Grenadines
239 Samoa
201 San Marino
205 São Tomé and Príncipe
190 Saudi Arabia
202 Senegal
187 Serbia
192 Seychelles
200 Sierra Leone
195 Singapore
199 Slovakia
197 Slovenia
191 Solomon Islands
203 Somalia
243 South Africa
87 South Georgia and the South Sandwich Islands
120 South Korea
65 Spain
128 Sri Lanka
193 Sudan
204 Suriname
198 Svalbard and Jan Mayen
208 Swaziland
194 Sweden
41 Switzerland
207 Syria
223 Taiwan
214 Tajikistan
224 Tanzania
213 Thailand
216 Timor-Leste
212 Togo
215 Tokelau
219 Tonga
221 Trinidad and Tobago
218 Tunisia
220 Turkey
217 Turkmenistan
209 Turks and Caicos Islands
222 Tuvalu
227 U.S. Minor Outlying Islands
235 U.S. Virgin Islands
226 Uganda
225 Ukraine
2 United Arab Emirates
74 United Kingdom
228 United States
229 Uruguay
230 Uzbekistan
237 Vanuatu
231 Vatican City
233 Venezuela
236 Vietnam
238 Wallis and Futuna
63 Western Sahara
241 Yemen
244 Zambia