Cikisi API Documentation

Welcome to Cikisi 2.0 API.
Here you can find all available requests to our API.

Quick reference
‍These parameters are always necessary, not only when signing in.

Questions/Comments
If you have any questions or comments, please let us know at:
‍getoar.gashi@cikisi.com

DISCLAIMER
{{variables}} are just there to pinpoint that you have to use your own values or values that we agreed upon such as {{API-url}} and {{VERSION}}.
{{API-url} - https://app.cikisi.com/api
‍{{version}} - v2
THIS IS BY NO MEANS AN ENVIRONMENT.

Authentication process
In the response headers(if authentication was successful) these five parameters can be found:
• access-tokentoken
• type
• expiry
• uid
• client
These five parameters are REQUIRED to make further requests to our API. These should be sent in the request headers.
These parameters should be included(in the headers) in every request made to our API.
‍These parameters are always necessary, not only when signing in.
‍Please check the image below.

General Parameters
All parameters below are OPTIONAL
‍
• per_page
The per_page parameter allows you to configure the maximum amount of hits to be returned

• page
The page parameter defines the Items that are published after that date.
‍
• date_from
Date from defines Items that are published after that date.(When publication date is not available in the orignal page, or not well identified by Cikisi, then the publication date is linked to the creation date)

• date_to
Date to defines Items that are published until that date.(When publication date is not available in the orignal page, or not well identified by Cikisi, then the publication date is linked to the creation date)

• sort_by
Sort by defines in which way you want to sort fetched Items: [publication_date, created_at, relevance, engagements, views]

• sort_direction
Sort direction defines in what order to view the items: [ASC, DESC]

• metadata
The value by default (metadata=0) allows you to receive the items with their basic metadata: [ id, title, description, content, publication_date, created_at, source information]Metadata=1 allows you to receive the items with all the metadata including [Name Entities and keywords, collections, tags, geolocations]

curl --location -g '{{CIKISI_URL}}/api/auth/sign_in' \
--form 'email="{{Email}}"' \
--form 'password="{{Password}}"'

curl --location -g '{{CIKISI_URL}}/api/v2/collections/{{collection_id}}/items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'

curl --location -g '{{CIKISI_URL}}/api/v2/themes/{{theme_id}}/items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'

Source Items

/v2/sources/:id/items

curl --location -g '{{CIKISI_URL}}/api/v2/sources/{{source_id}}/items?per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'

Tags Items

/v2/item_tags/items

curl --location -g '{{CIKISI_URL}}/api/v2/item_tags/items?name[]={{Tag%20Names}}&per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'

curl --location -g '{{CIKISI_URL}}api/v2/geolocated/items?radius={{Radius}}&lat={{Latitude}}&lon={{Longitude}}&keywords={{Keywords}}&per_page={{10}}&page={{0}}&date_from={{Date}}&date_to={{Date}}&sort_by={{Sort}}&sort_direction={{Sort%20Direction}}' \
--header 'access-token: {{Access-Token}}' \
--header 'token-type: {{Token-Type}}' \
--header 'client: {{Client}}' \
--header 'expiry: {{Expiry}}' \
--header 'uid: {{Uid}}'

Search Items

v2/search

{{keywords}}

Write your query using keywords AND/OR/NOT/*/ operators, in capital letters. You can also use brackets for grouping.

Eg.: ( football OR soccer ) AND ( "world cup" OR olymp* ) NOT (Brazil OR USA)