Collabim má API

K čemu vám může být API klíč?

API klíč funguje jako způsob, jakým můžete exportovat svoje data z Collabimu, pokud chcete využít nějaký externí nástroj či plugin.

Využití v praxi

API klíč si můžete zobrazit, nebo přegenerovat ve svém uživatelském profilu. K nastavení API se můžete dostat přes menu v pravém horním rohu a tam jen klikněte na API.

Zde již uvidíte svůj API klíč, který stačí zobrazit kliknutím na ikonu oka. API klíč můžete taktéž přegenerovat.
API

Nezobrazuje se vám v uživatelském profilu API klíč?

API klíč je dostupný pouze pro placené účty. Pokud používáte Free účet, pak API klíč není k dispozici. Taktéž je API klíč dostupný pouze pro uživatele, kteří mají roli majitele účtu, anebo alespoň roli administrátora. Více o uživatelských rolích se dočtete zde.

Lze přes API spouštět jednorázové analýzy?

Spouštění jednorázových analýz v API Collabim neumožňuje. Výjimku tvoří pouze příkaz pro Holy Grail Stats, což je funkce, která vrací pouze statistiky, nikoliv výsledky klíčových slov na doméně, jak standardně zobrazuje analýza Svatý Grál.

Holy Grail Stats slouží zejména pro vytažení domén, pro které má Collabim návrhy ze Svatého grálu. Seznam klíčových slov pak lze získat spuštěním samotné jednorázové analýzy. Vzhledem k tomu, že jsou jednorázové analýzy zpoplatněny kredity, neumožňujeme jejich provádění přes API.

Jak příkazy fungují?

Veškeré výstupy z API najdete zde:
https://collabimapi.docs.apiary.io/#

Funkce příkazu je omezena na jeden dotaz -> je možné omezit požadavek na menší období a tím předejdete možným limitacím. Vždy je nutné zadat štítek či ID klíčových slov (v případě, že si budete přát spustit příkaz pro všechna klíčová slova v projektu, je třeba tedy ke všem klíčovým slovům zadat příslušný štítek - a poté zadat tento štítek do příkazu).

Pokud se do výsledku nevejdou všechna klíčová slova, resp. pozice, vrací se pouze ty nejnovější -> veškeré informace jsou popsané zde na tomto odkazu:
https://collabimapi.docs.apiary.io/#reference/0/keyword-positions/by-interval-from,-to

Používáte-li Google Sheets - ty si pamatují poslední stav a pro aktualizaci dat je třeba buňku se vzorcem =IMPORTDATA() promazat a vložit ji tam znovu. Používáte-li pro výstup PowerBI, tam nebudete používat formát CSV, ale JSON - což je právě struktura, kterou API endpointy vrací.

Videotutoriál

Collabim má API

 

Další informace k API naleznete zde: https://www.collabim.cz/informace-o-api.html