API დოკუმენტაცია

PromART API

AI ხილვადობის (GEO) ანალიტიკა, ფაქტებით გადამოწმებული ცვლილებები და, სურვილისამებრ, API მიწოდება.

PromART ზომავს, როგორ საუბრობენ AI სისტემები თქვენს ბიზნესზე (ამჟამად რეალურად იზომება ChatGPT, Gemini და Claude; სხვა AI სისტემების მხარდაჭერა მუშავდება, იხ. GET /v1/engines), ხსნის მიზეზებს და ამზადებს ფაქტებით გადამოწმებულ ცვლილებებს. მთავარი პროდუქტი ანალიტიკის პანელია: ხილვადობა, ხმის წილი, პოზიცია, ტონალობა, ციტირებული წყაროები, კონკურენტები, დინამიკა, პასუხების სრული ტექსტები, რეკომენდაციები და PDF ანგარიშები. პანელი ზუსტად იმ მეთოდებს იყენებს, რომლებიც აქ არის აღწერილი.

სახელმძღვანელო

ავთენტიფიკაცია

ყველა /v1 მოთხოვნას (გარდა საჯარო მეთოდებისა, რომლებსაც „ავტორიზაციის გარეშე“ აწერია) Bearer ტოკენი სჭირდება. ტოკენი ორი სახისაა:

ტოკენი როგორ მიიღება შესაძლებლობები
sess_… პანელის სესია POST /v1/sessions სამუშაო სივრცის API გასაღებით (მოქმედებს 30 დღე) ყველაფერი; მუშაობს ყველა ტარიფზე
sk_live_… API გასაღები ჩანს მხოლოდ ერთხელ, სამუშაო სივრცის შექმნისას ყველაფერი, მაგრამ მხოლოდ API წვდომის მქონე ტარიფებზე (optimize, agency, agency_client, enterprise); სხვა ტარიფებზე პასუხია 403 api_access_required
Authorization: Bearer sk_live_…

მოთხოვნების ლიმიტები ტარიფზეა დამოკიდებული; 429 პასუხს Retry-After სათაური ახლავს. POST მოთხოვნებს შეგიძლიათ Idempotency-Key სათაური დაურთოთ: იმავე გასაღებით გამეორებულ მოთხოვნაზე სერვერი პირველ პასუხს ხელახლა დააბრუნებს (Idempotent-Replayed: true).

გაზომვა და ანალიტიკა

გაზომვის (/v1/runs, /v1/answers, /v1/visibility, /v1/share-of-voice, /v1/citations) და ანალიტიკის (/v1/overview, /v1/trends, /v1/competitors, /v1/sources, /v1/prompt-metrics, /v1/report, /v1/report.pdf) მეთოდები ერთსა და იმავე ფილტრებს იღებს: brand_id, engine, language, from, to (YYYY-MM-DD, ორივე თარიღის ჩათვლით). ანალიტიკა არჩეულ პერიოდს იმავე ხანგრძლივობის წინა პერიოდს ადარებს (ნაგულისხმევი პერიოდი — ბოლო 28 დღე). კვირა ორშაბათს იწყება.

ცვლილებები: ხელით განთავსება პანელიდან

ყოველ მომზადებულ ცვლილებას (GET /v1/content/items) ახლავს placement (რომელ URL‑ზე, გვერდის რომელ ადგილას, დანომრილი ნაბიჯები, გვერდზე არსებული ტექსტი, რომელსაც ცვლილება ჩაანაცვლებს, და თითოეული ნაწილი კოპირებისთვის მზა სახით) და facts (დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა). პროცესი API მიწოდების დამატებითი სერვისის გარეშე:

  1. proposed → POST /v1/content/{id}/approve → approved (მზადაა განსათავსებლად).
  2. კლიენტი ცვლილებას საიტზე ჩასვამს და გამოიძახებს POST /v1/content/{id}/applied → live; იწყება ექსპერიმენტი (ხელახალი გაზომვა იმ დროის გასვლის შემდეგ, რაც AI სისტემებს ცვლილების შესამჩნევად სჭირდებათ, ბოლოს კი — დატოვება ან დაბრუნება). ახალი გვერდებისთვის ამის ნაცვლად გამოიყენება POST /v1/pages/{id}/published რეალური URL‑ით.
  3. თუ ექსპერიმენტი ზრდას არ აჩვენებს (ან კლიენტი ცვლილებას დააბრუნებს), ცვლილება გადადის remove_requested სტატუსში მოსახსნელი ტექსტით; POST /v1/content/{id}/removed → rolled_back.

Google Business Profile‑ის ცვლილებები ყველა ტარიფზე ავტომატური რჩება: gbp_profile / gbp_post ცვლილების დამტკიცებისთანავე PromART მას Google‑ში ჩაწერს (ფუნქციის გადამრთველი google_bp).

API მიწოდება (ფასიანი დამატებითი სერვისი)

API მიწოდების დამატებითი სერვისით (სამუშაო სივრცის ველი api_delivery_enabled; იხ. GET /v1/usage‑ის ველი add_ons) საიტის ცვლილება დამტკიცებისთანავე live ხდება, თქვენი საიტის სერვერი კი მას გვერდის რენდერინგისას ითხოვს. დამატებითი სერვისის გარეშე ეს მეთოდები 403 addon_required‑ს აბრუნებს:

რა მოთხოვნა რისთვის
არსებული გვერდის ცვლილებები GET /v1/content?url=<page URL> მეტააღწერა, პასუხის აბზაცი, ხშირი კითხვები, JSON-LD სტრუქტურირებული მონაცემები და blocks[]
მხოლოდ სექციების ბლოკები GET /v1/pages/{url}/blocks (URL პროცენტული კოდირებით) ან GET /v1/pages/blocks?url= კონკრეტული სექციების ჩანაცვლება ან ჩასმა
შესაქმნელი ახალი გვერდები GET /v1/pages/new დამტკიცებული გვერდები: შემოთავაზებული URL, სათაური, სექციები (ცხრილებით), სტრუქტურირებული მონაცემები, შიდა ბმულები
ახალი გვერდის გამოქვეყნების დადასტურება POST /v1/pages/{id}/published PromART‑ს აცნობეთ რეალური URL, რომ გვერდის გაზომვა შეძლოს

ბრუნდება მხოლოდ API‑ით მიწოდებული ცვლილებები (delivery: api); ცვლილებები, რომლებიც კლიენტმა ხელით განათავსა, გვერდზე უკვე არის. პასუხების ქეშირება შეგიძლიათ 60 წამამდე (Cache-Control: private, max-age=60).

ბლოკების გამოყენება

თითოეული ბლოკი ასეთი ობიექტია: {block_id, selector, action, html, fact_ids, status}. დარენდერებულ HTML‑ში იპოვეთ CSS selector‑ის შესაბამისი პირველი ელემენტი და შეასრულეთ action:

action რას აკეთებს
replace ელემენტს (outer HTML) ცვლის html‑ით
append html‑ს სვამს ელემენტის ბოლო შვილობილ ელემენტად
prepend html‑ს სვამს ელემენტის პირველ შვილობილ ელემენტად
before html‑ს სვამს უშუალოდ ელემენტის წინ
after html‑ს სვამს უშუალოდ ელემენტის შემდეგ

თუ სელექტორს არც ერთი ელემენტი არ შეესაბამება, ბლოკი გამოტოვეთ. html უკვე გასუფთავებულია PromART‑ის უსაფრთხოების ფილტრით: დაშვებულია მხოლოდ p br h2 h3 h4 ul ol li strong em b i table thead tbody tr th td a (ბმულები მხოლოდ თქვენს ჰოსტებზე); სკრიპტებს, სტილებსა და ატრიბუტებს (a[href]‑ის გარდა) ის არ შეიცავს.

ხელმოწერის შემოწმება

GET /v1/content, GET /v1/pages/{url}/blocks, GET /v1/pages/blocks და GET /v1/pages/new პასუხებს ახლავს სათაური:

X-Sachino-Signature: sha256=<hex HMAC-SHA256(signing_secret, exact response body bytes)>

signing_secret‑ს აბრუნებს GET /v1/me. ხელმოწერა შეამოწმეთ პასუხის ნედლი ბაიტების მიხედვით, JSON‑ის პარსინგამდე; შედარება მუდმივ დროში (constant-time) უნდა სრულდებოდეს.

Node:

JavaScript
const crypto = require('crypto');
const ok = (raw, header, secret) => {
  const want = 'sha256=' + crypto.createHmac('sha256', secret).update(raw).digest('hex');
  return header && header.length === want.length &&
    crypto.timingSafeEqual(Buffer.from(header), Buffer.from(want));
};

PHP:

PHP
$want = 'sha256=' . hash_hmac('sha256', $rawBody, $secret);
$ok = hash_equals($want, $_SERVER['HTTP_X_SACHINO_SIGNATURE'] ?? $header);

Go:

Go
m := hmac.New(sha256.New, []byte(secret))
m.Write(raw)
ok := hmac.Equal([]byte(header), []byte("sha256="+hex.EncodeToString(m.Sum(nil))))

შეფერხებისას ქცევის წესი (სავალდებულო)

PromART‑მა თქვენი საიტის მუშაობა არასოდეს უნდა დაარღვიოს. თუ API მოთხოვნა ვერ შესრულდება, ტაიმაუტით შეწყდება (გირჩევთ 800 მწმ ტაიმაუტს), 2xx‑ისგან განსხვავებულ სტატუსს დააბრუნებს (მათ შორის 403 addon_required) ან ხელმოწერა არ დაემთხვევა, დაარენდერეთ თავდაპირველი გვერდი უცვლელად. გვერდის რენდერინგი PromART‑ის გამო არასოდეს უნდა შეფერხდეს.

IndexNow

GET /v1/indexnow-key აბრუნებს თქვენი სამუშაო სივრცის IndexNow გასაღებს და ფაილს, რომელიც თქვენმა დეველოპერმა ყველა დომენზე უნდა განათავსოს: https://<domain>/<key>.txt — ტექსტური ფაილი, რომელიც მხოლოდ გასაღებს შეიცავს, HTTP 200 სტატუსით და გადამისამართების გარეშე. ყოველი content.published მოვლენის შემდეგ (როცა ცვლილება API‑ით გამოქვეყნდება, ხელით განთავსებულად მოინიშნება ან ახალი გვერდის გამოქვეყნება დადასტურდება) PromART შეცვლილ URL‑ებს IndexNow‑ს უგზავნის; თითოეული გაგზავნა და მისი შედეგი ჩანს GET /v1/actions‑ში (არხი bing). როგორც კი ფაილი ხელმისაწვდომი გახდება, indexnow_key შემოწმება ok სტატუსს მიიღებს.

ვებჰუკები

მოვლენების გამოსაწერად გამოიძახეთ POST /v1/webhooks. მოვლენები: run.completed, visibility.changed, content.proposed, content.approved, content.published, content.removal_requested, content.rolled_back, facts.stale, alert.triggered, page.approved, integration.invited, review.request (ან * ყველა მოვლენისთვის).

თითოეული გაგზავნა POST მოთხოვნაა JSON შიგთავსით {id, type, created_at, data}; მას ახლავს სათაურები X-Sachino-Event: <type> და X-Sachino-Signature: sha256=<hex HMAC-SHA256(webhook secret, body)> (საიდუმლო გასაღები ვებჰუკის შექმნისას ბრუნდება). თუ თქვენი სერვერი 2xx‑ისგან განსხვავებულ სტატუსს დააბრუნებს, PromART გაგზავნას 3‑ჯერ გაიმეორებს.

ინტეგრაციები და ფუნქციების გადამრთველები

Google Business Profile (google_bp, წვდომის არე business.manage), Search Console (gsc) და GA4 (ga4, analytics.readonly) Google OAuth‑ით უკავშირდება; ტოკენები დაშიფრული სახით ინახება. Cloudflare (cloudflare) ჩასმული API ტოკენით უკავშირდება (ტოკენის უფლებები მხოლოდ ზონის ბოტების პარამეტრებზე ვრცელდება) და გამოიყენება მხოლოდ AI ბოტების დასაშვებად. cloudflare და google_bp სერვერის ფუნქციების გადამრთველებით ირთვება: როცა გადამრთველი გამორთულია, შესაბამისი მეთოდები 403 სტატუსს აბრუნებს feature_disabled კოდით, ხოლო GET /v1/integrations ამ ტიპს enabled: false მნიშვნელობით აჩვენებს.

შეცდომები

შეცდომები ერთიანი სტრუქტურით ბრუნდება: {"error": {"code": "...", "message": "..."}}. კოდები: unauthorized (401), plan_limit (402), api_access_required (403: API გასაღები ისეთ ტარიფზე, რომელიც API წვდომას არ მოიცავს; პანელი სესიებს იყენებს და ყველა ტარიფზე მუშაობს), addon_required (403: API მიწოდების დამატებითი სერვისი ჩართული არ არის), feature_disabled (403), not_found (404), invalid_request / invalid_json (400), rate_limited (429), internal (500). პროგრამულ ლოგიკაში დაეყრდენით code‑ს: ის ზოგადი და სტაბილურია. არარსებულ /v1 მისამართზე პასუხი ამავე სტრუქტურით მოდის, 404 სტატუსითა და not_found კოდით, ხოლო HTTP მეთოდზე, რომელსაც /v1 მისამართი არ უჭერს მხარს, — 405 სტატუსით, invalid_request კოდით და Allow სათაურით.

თუ შეცდომას უფრო კონკრეტული მიზეზი აქვს, მას ასევე ახლავს reason — შეტყობინების სტაბილური გასაღები, მაგ., http.err.brand_id_required ან core.err.not_found.brand — და params, ამ შეტყობინებაში ჩასმული მნიშვნელობები (თუ მნიშვნელობები არ არის, ველი გამოტოვებულია). თუ პარამეტრი რაიმეს ასახელებს (ტარიფს, სტატუსს, AI სისტემას), მისი მნიშვნელობა კოდია, როგორც ინგლისურ შეტყობინებებში. ასეთი შეცდომის message პასუხის ენაზეა (იხ. „ენა“); ინგლისურად კი ის ზუსტად ის ტექსტია, რაც reason‑ის დამატებამდე იყო.

JSON
{"error": {"code": "api_access_required",
           "message": "plan monitor does not include API access; use the panel, or upgrade to Optimize or higher",
           "reason": "http.err.api_access_required", "params": {"plan": "monitor"}}}

ენა

PromART‑ის მიერ დაწერილი ტექსტები (შეცდომების შეტყობინებები, შენიშვნები, რეკომენდაციები, განთავსების ნაბიჯები, გაფრთხილებები, მოსაწვევი გვერდი) შეიძლება დაბრუნდეს ქართულად, რუსულად ან ინგლისურად. ენა აირჩიეთ lang URL პარამეტრით (ka, ru ან en, ნებისმიერ მეთოდზე) ან Accept-Language სათაურით (გამოიყენება მხარდაჭერილი ენა ყველაზე მაღალი q‑მნიშვნელობით; lang მასზე უპირატესია). თუ არც ერთი არ არის მითითებული ან მითითებულია მხოლოდ მხარდაუჭერელი ენები, პასუხები ინგლისურად ბრუნდება, ზუსტად ისე, როგორც ადრე. ყოველი პასუხის ენა მითითებულია Content-Language სათაურში (ბრაუზერებს მისი წაკითხვა შეუძლიათ: Access-Control-Expose-Headers) და ყოველ პასუხს ახლავს Vary: Accept-Language. გამონაკლისია პასუხები, რომლებიც ყველა ენაზე ერთნაირია — GET /v1/content‑ისა და GET /v1/pages/{url}/blocks‑ის საიტის შიგთავსი, /healthz, შრიფტები და დოკუმენტაციის გვერდის ფაილები: მათ არც ერთი ეს სათაური არ ახლავს. /docs‑იც მოთხოვნილ ენაზე იხსნება (ქართულად, რუსულად ან ინგლისურად, Vary: Accept-Language‑ით); /openapi.yaml მხოლოდ ინგლისურადაა: მას ახლავს Content-Language: en, Vary‑ის გარეშე. Idempotency-Key‑ით გამეორებული POST მოთხოვნის პასუხი პირველი მოთხოვნის ენაზე ბრუნდება, იმავე Content-Language‑ით. კოდები, ID‑ები და თქვენი მონაცემები (ბრენდების სახელები, ფაქტები, პრომპტები, AI სისტემების პასუხები, საიტისთვის მომზადებული შიგთავსი) არასოდეს ითარგმნება.

პარამეტრები, რომლებსაც ყველა მეთოდი იღებს

ყველა /v1 მეთოდი და მოსაწვევი გვერდები ამ ორ პარამეტრს იღებს: ისინი განსაზღვრავს, რა ენაზე დაწერს PromART ტექსტებს. ქვემოთ თითოეულ მეთოდთან ისინი ერთ სტრიქონადაა ნაჩვენები.

პარამეტრიტიპი და აღწერა
langquerystring
იმ ტექსტების ენა, რომლებსაც PromART პასუხში წერს (შეცდომების შეტყობინებები, შენიშვნები, რეკომენდაციები, განთავსების ნაბიჯები, გაფრთხილებები, მოსაწვევი გვერდი): ka — ქართული, ru — რუსული, en — ინგლისური. Accept-Language‑ზე უპირატესია; ნებისმიერი სხვა მნიშვნელობა იგნორირდება. კოდები, ID‑ები და თქვენი მონაცემები არასოდეს ითარგმნება. იხ. სახელმძღვანელოს განყოფილება „ენა“.

დასაშვები მნიშვნელობები: ka, ru, en

Accept-Languageheaderstring
გამოიყენება, როცა lang არ არის მითითებული: აირჩევა მხარდაჭერილი ენა (ka, ru, en), რომელსაც ყველაზე მაღალი q‑მნიშვნელობა აქვს (თანაბრობისას — პირველი); თუ ასეთი არ არის, პასუხი ინგლისურადაა.

ანალიტიკა

ძირითადი მაჩვენებლები და მათი ცვლილება, დინამიკა კვირების მიხედვით, კონკურენტები, წყაროები, პრომპტების შედეგები, PDF ანგარიში.

ძირითადი მაჩვენებლები არჩეული პერიოდისა და იმავე ხანგრძლივობის წინა პერიოდისთვის

GET/v1/overview

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

ნაგულისხმევი პერიოდი — ბოლო 28 დღე. კლიენტის ხილვადობა, ხმის წილი, საშუალო პოზიცია (ნაკლები ჯობია) და ტონალობა.

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Overview

    • from string date
    • to string date
    • prev_from string date
    • prev_to string date
    • current KPI
    • previous KPI

კლიენტი და ყველა ბრენდი, რომელიც AI სისტემებმა დაასახელეს, წინა პერიოდის მნიშვნელობებით

GET/v1/competitors

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json CompetitorRow[]

    • name string
    • is_client boolean
    • mentions integer
    • visibility_pct number
    • sov_pct number
    • avg_position number
    • avg_sentiment number
    • prev_visibility_pct number
    • prev_sov_pct number

AI სისტემების მიერ ციტირებული წყაროები დომენების ან URL‑ების მიხედვით, ციტირებების რაოდენობით თითოეულ AI სისტემაში

GET/v1/sources

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
byquerystring

დასაშვები მნიშვნელობები: domain, urlნაგულისხმევი: domain

limitqueryinteger

ნაგულისხმევი: 100მაქსიმუმ 1000

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json SourceRow[]

    • url string
      მხოლოდ by=url პარამეტრით
    • domain string
    • owner string

      დასაშვები მნიშვნელობები: client, competitor, third_party

    • count integer
      მციტირებელი პასუხების რაოდენობა
    • share_pct number
    • engines map<string, integer>

ხილვადობა და პოზიცია პრომპტების მიხედვით: საერთო და თითოეულ AI სისტემაში (ჯერ დაბალი ხილვადობა)

GET/v1/prompt-metrics

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json PromptRow[]

    • prompt_id string
    • text string
    • language string
    • target_url string
    • answers integer
    • visibility_pct number
    • avg_position number
    • top_competitor string
    • engines map<string, EngineCell>

ბრენდის PDF ანგარიში არჩეული პერიოდისთვის

GET/v1/report.pdf

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

ძირითადი მაჩვენებლები და მათი ცვლილება, ხილვადობის გრაფიკი კვირების მიხედვით (12 კვირა), კონკურენტები, AI სისტემები, ციტირებული წყაროები, ცვლილებები და ექსპერიმენტები, რეკომენდაციები. ნაგულისხმევი პერიოდი — ბოლო 28 დღე. წარწერები, რიცხვები და თარიღები პასუხის ენაზეა (lang, თუ არ არის — Accept-Language, თუ არც ეს — ინგლისური; იხ. „ენა“); ბრენდების სახელები, დომენები და URL‑ები უცვლელი რჩება.

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
enginequerystring
languagequerystring
მხოლოდ ამ ენაზე მიღებული პასუხები (მონაცემების ფილტრი და არა PDF‑ის ენა)
fromquerystring date
toquerystring date
ჩათვლით
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 PDF (ჩამოსატვირთი ფაილი) სახელით sachino-<domain>-<to>.pdf

    application/pdf string binary

  • 400 შეცდომა

    application/json Error

  • 404 შეცდომა

    application/json Error

API მიწოდება

API მიწოდების ფასიანი დამატებითი სერვისი: მეთოდები, რომლებსაც კლიენტის საიტის სერვერი გვერდების რენდერინგისას იძახებს.

ერთი გვერდის მოქმედი ცვლილებები (ხელმოწერით; საჭიროა API მიწოდება)

GET/v1/content

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

საჭიროა ფასიანი დამატებითი სერვისი API მიწოდება; მის გარეშე პასუხია 403 addon_required. აბრუნებს API‑ით მიწოდებულ ცვლილებებს (delivery: api). გამოიძახეთ გვერდის რენდერინგისას. შეამოწმეთ X-Sachino-Signature და ნებისმიერი შეცდომის, ტაიმაუტის (გირჩევთ 800 მწმ), 2xx‑ისგან განსხვავებული სტატუსის ან ხელმოწერის შეუსაბამობისას გამოიყენეთ თავდაპირველი გვერდი.

პარამეტრები

პარამეტრიტიპი და აღწერა
urlqueryსავალდებულოstring uri
გვერდის URL (PromART მას ნორმალიზებას უკეთებს)
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 მიწოდების ობიექტი

    სათაურები

    • X-Sachino-Signature string
      sha256= + hex(HMAC-SHA256(signing_secret GET /v1/me‑დან, პასუხის შიგთავსის ზუსტი ბაიტები))
    • Cache-Control string

    application/json Delivery

    • url string
    • version integer
      იზრდება ამ URL‑ის ყოველი გამოქვეყნებული ცვლილებისას
    • meta_description string
    • answer_block string
    • faq object[]
      ველები: 3
      • q string
      • a string
      • fact_ids string[]
    • schema object
      JSON-LD
    • blocks BlockItem[]
    • content_ids string[]
    • signature string
      მოძველებული ველი: შიგთავსის HMAC ამ ველის გარეშე. ამის ნაცვლად შეამოწმეთ X-Sachino-Signature სათაური.
  • 400 შეცდომა

    application/json Error

  • 401 შეცდომა

    application/json Error

  • 403 addon_required: ამ სამუშაო სივრცეში API მიწოდების დამატებითი სერვისი ჩართული არ არის

    application/json Error

გვერდის სექციების ბლოკები, URL პარამეტრით (ხელმოწერით; საჭიროა API მიწოდება)

GET/v1/pages/blocks

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

საჭიროა ფასიანი დამატებითი სერვისი API მიწოდება; მის გარეშე პასუხია 403 addon_required. მოქმედ ბლოკებად ბრუნდება მხოლოდ API‑ით მიწოდებული ბლოკები.

პარამეტრები

პარამეტრიტიპი და აღწერა
urlqueryსავალდებულოstring uri
statusquerystring
ნაგულისხმევად მხოლოდ მოქმედი ბლოკები; all შემოთავაზებულ და ძველ ბლოკებსაც მოიცავს

დასაშვები მნიშვნელობები: all

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 ბლოკები

    სათაურები

    • X-Sachino-Signature string
      sha256= + hex(HMAC-SHA256(signing_secret GET /v1/me‑დან, პასუხის შიგთავსის ზუსტი ბაიტები))

    application/json BlockItem[]

    • content_id string
    • block_id string
    • selector string
    • action string

      დასაშვები მნიშვნელობები: replace, append, prepend, before, after

    • html string
    • fact_ids string[]
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

  • 400 შეცდომა

    application/json Error

  • 403 addon_required: ამ სამუშაო სივრცეში API მიწოდების დამატებითი სერვისი ჩართული არ არის

    application/json Error

გვერდის სექციების ბლოკები (ხელმოწერით; საჭიროა API მიწოდება)

GET/v1/pages/{url}/blocks

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

არსებული გვერდის კონკრეტული სექციების ჩასანაცვლებელი ტექსტი. url გვერდის URL‑ია, პროცენტული კოდირებით (encodeURIComponent). საჭიროა ფასიანი დამატებითი სერვისი API მიწოდება; მის გარეშე პასუხია 403 addon_required.

პარამეტრები

პარამეტრიტიპი და აღწერა
urlpathსავალდებულოstring

მაგალითი: https%3A%2F%2Fexample.com%2Fservices

statusquerystring
ნაგულისხმევად მხოლოდ მოქმედი ბლოკები; all შემოთავაზებულ და ძველ ბლოკებსაც მოიცავს

დასაშვები მნიშვნელობები: all

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 ბლოკები

    სათაურები

    • X-Sachino-Signature string
      sha256= + hex(HMAC-SHA256(signing_secret GET /v1/me‑დან, პასუხის შიგთავსის ზუსტი ბაიტები))

    application/json BlockItem[]

    • content_id string
    • block_id string
    • selector string
    • action string

      დასაშვები მნიშვნელობები: replace, append, prepend, before, after

    • html string
    • fact_ids string[]
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

  • 400 შეცდომა

    application/json Error

  • 403 addon_required: ამ სამუშაო სივრცეში API მიწოდების დამატებითი სერვისი ჩართული არ არის

    application/json Error

შესაქმნელი ახალი გვერდები (ხელმოწერით; საჭიროა API მიწოდება)

GET/v1/pages/new

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

დამტკიცებული გვერდები შემოთავაზებული URL‑ით, სათაურით, სექციებით (HTML, ცხრილების ჩათვლით), JSON-LD სტრუქტურირებული მონაცემებითა და შიდა ბმულებით. შექმენით გვერდი და შემდეგ დაადასტურეთ POST /v1/pages/{id}/published‑ით. საჭიროა ფასიანი დამატებითი სერვისი API მიწოდება; მის გარეშე პასუხია 403 addon_required (პანელში ახალი გვერდები ჩანს GET /v1/content/items?kind=page‑ში).

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
statusquerystring
ნაგულისხმევად approved და live

დასაშვები მნიშვნელობები: approved, live, proposed

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 გვერდები (page ტიპის ცვლილებები; იხ. body.page)

    სათაურები

    • X-Sachino-Signature string
      sha256= + hex(HMAC-SHA256(signing_secret GET /v1/me‑დან, პასუხის შიგთავსის ზუსტი ბაიტები))

    application/json Content[]

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 403 addon_required: ამ სამუშაო სივრცეში API მიწოდების დამატებითი სერვისი ჩართული არ არის

    application/json Error

გამოქვეყნებული გვერდის მისამართის დადასტურება

POST/v1/pages/{id}/published

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

გვერდი გამოქვეყნებულად მოინიშნება, შესაბამის პრომპტებს სამიზნე URL‑ად ეს გვერდი მიეთითება, ქმედება ჟურნალში ჩაიწერება, იგზავნება content.published, URL IndexNow‑ს ეგზავნება და გვერდის გასაზომად ექსპერიმენტი იწყება.

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • url string uri
    რეალური URL ბრენდის დომენზე; ნაგულისხმევად — შემოთავაზებული URL

პასუხები

  • 200 OK

    application/json Content

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 400 შეცდომა

    application/json Error

გვერდები

ახალი გვერდების შეთავაზება სერვისებისთვის, რომლებსაც საიტზე გვერდი არ აქვს

POST/v1/pages/generate

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • max integer

    ნაგულისხმევი: 3მაქსიმუმ 10

პასუხები

  • 201 შემოთავაზებული გვერდები

    application/json Content[]

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა

საიტის შემოწმება

საიტის აუდიტი AI სისტემებისთვის, ინსტრუქციებით დეველოპერისთვის

GET/v1/site-checks

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

ინდექსაცია (Search Console‑ით, თუ დაკავშირებულია), AI ბოტების წვდომა robots.txt‑სა და CDN‑ზე, საიტის რუკა, IndexNow‑ის გასაღების ფაილი, გვერდის ჩატვირთვა, noindex, JavaScript‑ის გარეშე ხილული ტექსტი, სიჩქარე. საიტი ხელახლა სკანირდება, თუ ბოლო შემოწმება 1 საათზე ძველია ან მოთხოვნაში refresh არის მითითებული.

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
refreshquerystring

დასაშვები მნიშვნელობები: 1, true

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json SiteCheck[]

    • id string
    • check string

      დასაშვები მნიშვნელობები: robots_ai_bots, cdn_ai_bots, sitemap, indexnow_key, fetch, noindex, js_rendering, speed, google_index

    • target string
      დომენი ან URL
    • status string

      დასაშვები მნიშვნელობები: ok, warn, fail, unknown

    • detail string
    • instruction string
      ზუსტი დავალება კლიენტისთვის ან დეველოპერისთვის
    • fix string
      ავტომატური გამოსწორება, რომლის შესრულებაც PromART‑ს შეუძლია, მაგ., cloudflare:allow_ai_crawlers
    • source string

      დასაშვები მნიშვნელობები: crawl, gsc, cloudflare

    • checked_at string date-time

სამუშაო სივრცის IndexNow გასაღები და ფაილის განთავსების ინსტრუქციები

GET/v1/indexnow-key

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json IndexNowInfo

    • key string
    • files object[]
      ველები: 5
      • brand_id string
      • domain string
      • url string
        https://<domain>/<key>.txt
      • content string
        ფაილის ზუსტი შიგთავსი (გასაღები)
      • status string
        საიტის ბოლო შემოწმების შედეგი

        დასაშვები მნიშვნელობები: ok, fail, unknown

    • instructions string[]

ინტეგრაციები

კავშირები, ხელმისაწვდომი ტიპები და ტექსტები კლიენტისთვის

GET/v1/integrations

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json object

    • items Integration[]
      ველები: 12
      • id string
      • brand_id string
      • kind string

        დასაშვები მნიშვნელობები: google_bp, gsc, ga4, cloudflare

      • status string

        დასაშვები მნიშვნელობები: invited, pending, connected, needs_selection, error, revoked

      • account string
      • scopes string
      • config map<string, string>
      • invite_email string
      • last_sync_at string date-time
      • last_error string
      • created_at string date-time
      • updated_at string date-time
    • kinds map<string, IntegrationKind>
      ველები: 4
      • scope string
        Google OAuth‑ის წვდომის არე
      • access string
      • does string
      • enabled boolean
        false, როცა სერვერზე ფუნქციის გადამრთველი გამორთულია
    • wording map<string, object>
      კლიენტისთვის განკუთვნილი ტექსტები ენების მიხედვით (en, ka, ru)
      ველები: 4
      • connect string
      • invite string
      • button string
      • review string

დაკავშირების დაწყება

POST/v1/integrations/{kind}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

Google‑ის ტიპებისთვის პასუხში ბრუნდება auth_url (გახსენით ის ბრაუზერში). Cloudflare‑ისთვის საჭიროა token. თუ invite_email‑ს მიუთითებთ, ამის ნაცვლად შეიქმნება ერთჯერადი ბმული იმისთვის, ვინც ანგარიშს მართავს (ბმული integration.invited ვებჰუკით გაიგზავნება). cloudflare‑ისა და google_bp‑ისთვის პასუხია 403 feature_disabled, როცა მათი გადამრთველი გამორთულია.

პარამეტრები

პარამეტრიტიპი და აღწერა
kindpathსავალდებულოstring

დასაშვები მნიშვნელობები: google_bp, gsc, ga4, cloudflare

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • token string
    Cloudflare‑ის API ტოკენი (Zone > Bot Management > Edit)
  • invite_email string email

პასუხები

  • 201 დაიწყო

    application/json ConnectResult

    • integration Integration
    • auth_url string
      Google‑ის თანხმობის გვერდი
    • invite_url string
      ერთჯერადი ბმული იმისთვის, ვინც ანგარიშს მართავს
    • note string
  • 400 შეცდომა

    application/json Error

  • 403 შეცდომა

    application/json Error

მდებარეობის / საიტის / რესურსის არჩევა (სტატუსი needs_selection)

PATCH/v1/integrations/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • config map<string, string>

პასუხები

  • 200 OK

    application/json Integration

    • id string
    • brand_id string
    • kind string

      დასაშვები მნიშვნელობები: google_bp, gsc, ga4, cloudflare

    • status string

      დასაშვები მნიშვნელობები: invited, pending, connected, needs_selection, error, revoked

    • account string
    • scopes string
    • config map<string, string>
    • invite_email string
    • last_sync_at string date-time
    • last_error string
    • created_at string date-time
    • updated_at string date-time

გათიშვა (Google‑ის ტოკენებს აუქმებს)

DELETE/v1/integrations/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 204 გათიშულია

ანგარიშის სინქრონიზაცია ახლავე

POST/v1/integrations/{id}/sync

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Integration

    • id string
    • brand_id string
    • kind string

      დასაშვები მნიშვნელობები: google_bp, gsc, ga4, cloudflare

    • status string

      დასაშვები მნიშვნელობები: invited, pending, connected, needs_selection, error, revoked

    • account string
    • scopes string
    • config map<string, string>
    • invite_email string
    • last_sync_at string date-time
    • last_error string
    • created_at string date-time
    • updated_at string date-time
  • 403 შეცდომა

    application/json Error

Cloudflare‑ის ქმედების შესრულება

POST/v1/integrations/{id}/actions

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

ერთადერთი ქმედებაა allow_ai_crawlers (გამორთავს Block AI bots პარამეტრს; მისი დაბრუნება ქმედებების ჟურნალიდან შეიძლება). საჭიროა ჩართული cloudflare გადამრთველი.

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • action string სავალდებულო

    დასაშვები მნიშვნელობები: allow_ai_crawlers

პასუხები

  • 201 ჟურნალში ჩაწერილი ქმედება

    application/json Action

    • id string
    • brand_id string
    • channel string

      დასაშვები მნიშვნელობები: site, gbp, gsc, bing, cloudflare, reviews

    • kind string
    • target string
    • summary string
    • content_id string
    • integration_id string
    • before any
      წინა მნიშვნელობა (თუ ცნობილია)
    • after any
      ახალი მნიშვნელობა
    • status string

      დასაშვები მნიშვნელობები: done, failed, rolled_back

    • error string
    • rollback_url string
      გასაუქმებლად გააგზავნეთ POST მოთხოვნა ამ მისამართზე (მხოლოდ შექცევადი ქმედებებისთვის)
    • created_at string date-time
    • rolled_back_at string date-time
  • 400 შეცდომა

    application/json Error

  • 403 შეცდომა

    application/json Error

Business Profile‑ის ტექსტის მომზადება დადასტურებული ფაქტებით

POST/v1/gbp/profile

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

საჭიროა ჩართული google_bp გადამრთველი და დაკავშირებული Business Profile.

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო

პასუხები

  • 201 მომზადდა

    application/json Content[]

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 403 შეცდომა

    application/json Error

ვიზიტები AI სისტემებიდან (GA4, ბოლო 28 დღე)

GET/v1/ai-traffic

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json TrafficRow[]

    • source string
    • sessions integer
    • from string date
    • to string date

ქმედებების ჟურნალი

ყველა ცვლილება, რომელიც PromART‑მა შეიტანა, ნებისმიერ არხსა და ანგარიშში

GET/v1/actions

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
channelquerystring

დასაშვები მნიშვნელობები: site, gbp, gsc, bing, cloudflare, reviews

limitqueryinteger

ნაგულისხმევი: 100მაქსიმუმ 1000

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Action[]

    • id string
    • brand_id string
    • channel string

      დასაშვები მნიშვნელობები: site, gbp, gsc, bing, cloudflare, reviews

    • kind string
    • target string
    • summary string
    • content_id string
    • integration_id string
    • before any
      წინა მნიშვნელობა (თუ ცნობილია)
    • after any
      ახალი მნიშვნელობა
    • status string

      დასაშვები მნიშვნელობები: done, failed, rolled_back

    • error string
    • rollback_url string
      გასაუქმებლად გააგზავნეთ POST მოთხოვნა ამ მისამართზე (მხოლოდ შექცევადი ქმედებებისთვის)
    • created_at string date-time
    • rolled_back_at string date-time

შექცევადი ქმედების გაუქმება

POST/v1/actions/{id}/rollback

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Action

    • id string
    • brand_id string
    • channel string

      დასაშვები მნიშვნელობები: site, gbp, gsc, bing, cloudflare, reviews

    • kind string
    • target string
    • summary string
    • content_id string
    • integration_id string
    • before any
      წინა მნიშვნელობა (თუ ცნობილია)
    • after any
      ახალი მნიშვნელობა
    • status string

      დასაშვები მნიშვნელობები: done, failed, rolled_back

    • error string
    • rollback_url string
      გასაუქმებლად გააგზავნეთ POST მოთხოვნა ამ მისამართზე (მხოლოდ შექცევადი ქმედებებისთვის)
    • created_at string date-time
    • rolled_back_at string date-time
  • 400 შეცდომა

    application/json Error

სამუშაო სივრცე

გამოსვლა (მიმდინარე სესიის წაშლა)

DELETE/v1/sessions

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 204 სესია დასრულდა
  • 401 შეცდომა

    application/json Error

მიმდინარე სამუშაო სივრცე, ტარიფი და ხელმოწერის საიდუმლო გასაღები

GET/v1/me

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json object

    • workspace Workspace
      ველები: 8
      • id string
      • name string
      • plan string
      • parent_id string
      • auto_publish_technical boolean
        ტექნიკური ცვლილებების ავტომატური განთავსება (საჭიროა API მიწოდების დამატებითი სერვისი)
      • api_delivery_enabled boolean
        API მიწოდების ფასიანი დამატებითი სერვისი
      • auto_fixes boolean
        ცვლილებები ავტომატურად მზადდება ყოველი დიაგნოსტიკის შემდეგ. გამორთული = მხოლოდ ანალიტიკა, ცვლილებები მოთხოვნით.
      • created_at string date-time
    • plan Plan
      ველები: 16
      • name string
      • price_gel integer
      • prompts integer
      • engines integer
      • brands integer
      • competitors integer
      • languages integer
      • answers_per_month integer
      • interval string
      • daily_prompts integer
      • diagnosis boolean
      • autopilot boolean
      • child_workspaces integer
      • overage string

        დასაშვები მნიშვნელობები: block, bill

      • rate_limit_rps number
      • api_access boolean
        API გასაღებებით API‑ის გამოძახება შესაძლებელია (პანელი ყველა ტარიფზე მუშაობს)
    • signing_secret string
      გასაღები, რომლითაც შიგთავსის მეთოდების პასუხებში X-Sachino-Signature მოწმდება
  • 401 შეცდომა

    application/json Error

სამუშაო სივრცის პარამეტრები

PATCH/v1/settings

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • auto_publish_technical boolean
    ტექნიკური ცვლილებების (სტრუქტურირებული მონაცემები, მეტატეგები) და Cloudflare‑ში AI ბოტების წვდომის ცვლილებების განთავსება დამტკიცების გარეშე
  • auto_fixes boolean
    ცვლილებების ავტომატური მომზადება ყოველი დიაგნოსტიკის შემდეგ (Autopilot‑იანი ტარიფები). გამორთული (ნაგულისხმევად) = მხოლოდ ანალიტიკა: ცვლილებები მზადდება, როცა POST /v1/fixes‑ს გამოიძახებთ. Autopilot‑ის გარეშე ჩართვა 402 plan_limit‑ს აბრუნებს.

პასუხები

  • 200 სამუშაო სივრცე

    application/json Workspace

    • id string
    • name string
    • plan string
    • parent_id string
    • auto_publish_technical boolean
      ტექნიკური ცვლილებების ავტომატური განთავსება (საჭიროა API მიწოდების დამატებითი სერვისი)
    • api_delivery_enabled boolean
      API მიწოდების ფასიანი დამატებითი სერვისი
    • auto_fixes boolean
      ცვლილებები ავტომატურად მზადდება ყოველი დიაგნოსტიკის შემდეგ. გამორთული = მხოლოდ ანალიტიკა, ცვლილებები მოთხოვნით.
    • created_at string date-time

ამ სააგენტოს კლიენტების სამუშაო სივრცეები

GET/v1/workspaces

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Workspace[]

    • id string
    • name string
    • plan string
    • parent_id string
    • auto_publish_technical boolean
      ტექნიკური ცვლილებების ავტომატური განთავსება (საჭიროა API მიწოდების დამატებითი სერვისი)
    • api_delivery_enabled boolean
      API მიწოდების ფასიანი დამატებითი სერვისი
    • auto_fixes boolean
      ცვლილებები ავტომატურად მზადდება ყოველი დიაგნოსტიკის შემდეგ. გამორთული = მხოლოდ ანალიტიკა, ცვლილებები მოთხოვნით.
    • created_at string date-time

კლიენტის სამუშაო სივრცის შექმნა (სააგენტოს ტარიფები)

POST/v1/workspaces

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • name string სავალდებულო

პასუხები

  • 201 შეიქმნა; API გასაღები ახლავე შეინახეთ: ის მეორედ აღარ გამოჩნდება

    application/json object

    • workspace Workspace
    • api_key string
    • note string
  • 402 შეცდომა

    application/json Error

AI სისტემები და მათთან წვდომის მარშრუტები

GET/v1/engines

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json object[]

    • name string
    • phase string

      დასაშვები მნიშვნელობები: mvp, phase2, phase3

    • routes string[]
      კონფიგურირებული მარშრუტები რიგითობით (პირველი — ძირითადი, დანარჩენი — სარეზერვო); mock პასუხები სიმულაციაა
    • live boolean
      ამ AI სისტემისთვის არსებობს პროვაიდერის რეალური ადაპტერი (chatgpt — openai‑ით, gemini — gemini‑ით, claude — anthropic‑ით). რეალურ პასუხებს ის მხოლოდ მაშინ აბრუნებს, როცა routes‑ში ეს პროვაიდერი პირველია

ამ თვის მოხმარება ტარიფის ლიმიტებთან შედარებით და დამატებითი სერვისები

GET/v1/usage

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Usage

    • plan Plan
    • month string
    • answers integer
    • queued_jobs integer
    • prompts integer
    • brands integer
    • overage_answers integer
    • child_workspaces integer
    • add_ons object[]
      ველები: 4
      • name string
      • title string
      • description string
      • enabled boolean

კატალოგი

ბრენდები, ფაქტები და პრომპტები.

ბრენდების სია

GET/v1/brands

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Brand[]

    • id string მხოლოდ წასაკითხი
    • name string
    • domain string
    • industry string
    • city string
    • variants string[]
      სახელის სხვა ვარიანტები (მაგ., ქართულად, რუსულად)
    • competitors Competitor[]
    • languages string[]
    • markets string[]
    • engines string[]
    • channel string
      api: თქვენი საიტის სერვერი PromART‑ის API‑ს მიმართავს; gbp: მხოლოდ Business Profile

      დასაშვები მნიშვნელობები: api, gbp

    • created_at string date-time მხოლოდ წასაკითხი

ბრენდის შექმნა

POST/v1/brands

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json Brand

  • name string
  • domain string
  • industry string
  • city string
  • variants string[]
    სახელის სხვა ვარიანტები (მაგ., ქართულად, რუსულად)
  • competitors Competitor[]
  • languages string[]
  • markets string[]
  • engines string[]
  • channel string
    api: თქვენი საიტის სერვერი PromART‑ის API‑ს მიმართავს; gbp: მხოლოდ Business Profile

    დასაშვები მნიშვნელობები: api, gbp

პასუხები

  • 201 შეიქმნა

    application/json Brand

    • id string მხოლოდ წასაკითხი
    • name string
    • domain string
    • industry string
    • city string
    • variants string[]
      სახელის სხვა ვარიანტები (მაგ., ქართულად, რუსულად)
    • competitors Competitor[]
    • languages string[]
    • markets string[]
    • engines string[]
    • channel string
      api: თქვენი საიტის სერვერი PromART‑ის API‑ს მიმართავს; gbp: მხოლოდ Business Profile

      დასაშვები მნიშვნელობები: api, gbp

    • created_at string date-time მხოლოდ წასაკითხი
  • 400 შეცდომა

    application/json Error

  • 402 შეცდომა

    application/json Error

ბრენდის მიღება

GET/v1/brands/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Brand

    • id string მხოლოდ წასაკითხი
    • name string
    • domain string
    • industry string
    • city string
    • variants string[]
      სახელის სხვა ვარიანტები (მაგ., ქართულად, რუსულად)
    • competitors Competitor[]
    • languages string[]
    • markets string[]
    • engines string[]
    • channel string
      api: თქვენი საიტის სერვერი PromART‑ის API‑ს მიმართავს; gbp: მხოლოდ Business Profile

      დასაშვები მნიშვნელობები: api, gbp

    • created_at string date-time მხოლოდ წასაკითხი
  • 404 შეცდომა

    application/json Error

ბრენდის განახლება (მოთხოვნაში მითითებული ველები ძველ მნიშვნელობებს ცვლის)

PATCH/v1/brands/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json Brand

  • name string
  • domain string
  • industry string
  • city string
  • variants string[]
    სახელის სხვა ვარიანტები (მაგ., ქართულად, რუსულად)
  • competitors Competitor[]
  • languages string[]
  • markets string[]
  • engines string[]
  • channel string
    api: თქვენი საიტის სერვერი PromART‑ის API‑ს მიმართავს; gbp: მხოლოდ Business Profile

    დასაშვები მნიშვნელობები: api, gbp

პასუხები

  • 200 OK

    application/json Brand

    • id string მხოლოდ წასაკითხი
    • name string
    • domain string
    • industry string
    • city string
    • variants string[]
      სახელის სხვა ვარიანტები (მაგ., ქართულად, რუსულად)
    • competitors Competitor[]
    • languages string[]
    • markets string[]
    • engines string[]
    • channel string
      api: თქვენი საიტის სერვერი PromART‑ის API‑ს მიმართავს; gbp: მხოლოდ Business Profile

      დასაშვები მნიშვნელობები: api, gbp

    • created_at string date-time მხოლოდ წასაკითხი
  • 400 შეცდომა

    application/json Error

ფაქტების სია

GET/v1/facts

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
statusquerystring

დასაშვები მნიშვნელობები: confirmed, unconfirmed

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Fact[]

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • key string
    • value string
    • lang string
      ენის კოდი ან any
    • url string
    • source string

      დასაშვები მნიშვნელობები: api, form, extracted

    • status string

      დასაშვები მნიშვნელობები: confirmed, unconfirmed

    • updated_at string date-time მხოლოდ წასაკითხი

ფაქტების დამატება (ერთი ობიექტი ან მასივი)

POST/v1/facts

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

ფაქტები ერთადერთი წყაროა, რომელსაც PromART ტექსტის წერისას ეყრდნობა; ყოველი მომზადებული წინადადება ფაქტების ID‑ებს უთითებს.

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json ერთ-ერთი

  1. ვარიანტი 1 Fact

    • brand_id string
    • key string
    • value string
    • lang string
      ენის კოდი ან any
    • url string
    • source string

      დასაშვები მნიშვნელობები: api, form, extracted

    • status string

      დასაშვები მნიშვნელობები: confirmed, unconfirmed

  2. ვარიანტი 2 Fact[]

    • brand_id string
    • key string
    • value string
    • lang string
      ენის კოდი ან any
    • url string
    • source string

      დასაშვები მნიშვნელობები: api, form, extracted

    • status string

      დასაშვები მნიშვნელობები: confirmed, unconfirmed

პასუხები

  • 201 შეიქმნა

    application/json Fact[]

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • key string
    • value string
    • lang string
      ენის კოდი ან any
    • url string
    • source string

      დასაშვები მნიშვნელობები: api, form, extracted

    • status string

      დასაშვები მნიშვნელობები: confirmed, unconfirmed

    • updated_at string date-time მხოლოდ წასაკითხი
  • 400 შეცდომა

    application/json Error

ფაქტის რედაქტირება ან დადასტურება

PATCH/v1/facts/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

თუ ფაქტის მნიშვნელობა შეიცვლება, ყველა ცვლილება, რომელიც ამ ფაქტს ეყრდნობა, მოძველებულად მოინიშნება და ხელახლა მოსამზადებლად რიგში დადგება.

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • key string
  • value string
  • lang string
  • url string
  • status string

    დასაშვები მნიშვნელობები: confirmed

პასუხები

  • 200 OK

    application/json Fact

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • key string
    • value string
    • lang string
      ენის კოდი ან any
    • url string
    • source string

      დასაშვები მნიშვნელობები: api, form, extracted

    • status string

      დასაშვები მნიშვნელობები: confirmed, unconfirmed

    • updated_at string date-time მხოლოდ წასაკითხი
  • 404 შეცდომა

    application/json Error

ფაქტის წაშლა

DELETE/v1/facts/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 წაიშალა

    application/json object

    • deleted boolean
  • 404 შეცდომა

    application/json Error

დაუდასტურებელი ფაქტების ამოღება გვერდიდან

POST/v1/facts/extract

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • url string სავალდებულო

პასუხები

  • 201 ამოღებულია (სტატუსი: unconfirmed)

    application/json Fact[]

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • key string
    • value string
    • lang string
      ენის კოდი ან any
    • url string
    • source string

      დასაშვები მნიშვნელობები: api, form, extracted

    • status string

      დასაშვები მნიშვნელობები: confirmed, unconfirmed

    • updated_at string date-time მხოლოდ წასაკითხი

პრომპტების სია

GET/v1/prompts

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
activequerystring
მხოლოდ აქტიური პრომპტები

დასაშვები მნიშვნელობები: true

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Prompt[]

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • text string
    • language string
    • market string
    • target_url string
    • active boolean
    • created_at string date-time მხოლოდ წასაკითხი

პრომპტების დამატება (მასივი ან {"prompts":[...]})

POST/v1/prompts

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json ერთ-ერთი

  1. ვარიანტი 1 Prompt[]

    • brand_id string
    • text string
    • language string
    • market string
    • target_url string
    • active boolean
  2. ვარიანტი 2 object

    • prompts Prompt[]
      ველები: 6
      • brand_id string
      • text string
      • language string
      • market string
      • target_url string
      • active boolean

პასუხები

  • 201 შეიქმნა

    application/json Prompt[]

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • text string
    • language string
    • market string
    • target_url string
    • active boolean
    • created_at string date-time მხოლოდ წასაკითხი
  • 400 შეცდომა

    application/json Error

  • 402 შეცდომა

    application/json Error

პრომპტის განახლება

PATCH/v1/prompts/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • active boolean
  • target_url string
  • text string

პასუხები

  • 200 OK

    application/json Prompt

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • text string
    • language string
    • market string
    • target_url string
    • active boolean
    • created_at string date-time მხოლოდ წასაკითხი

პრომპტის წაშლა

DELETE/v1/prompts/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 წაიშალა

    application/json object

    • deleted boolean

ბრენდისთვის პრომპტების შეთავაზება (არ ინახება)

POST/v1/prompts/suggest

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • per_language integer

პასუხები

  • 200 OK

    application/json Prompt[]

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • text string
    • language string
    • market string
    • target_url string
    • active boolean
    • created_at string date-time მხოლოდ წასაკითხი

გაზომვა

გაზომვების სია

GET/v1/runs

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
limitqueryinteger

ნაგულისხმევი: 50მაქსიმუმ 500

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Run[]

    • id string
    • brand_id string
    • kind string

      დასაშვები მნიშვნელობები: baseline, scheduled, daily, manual, remeasure

    • status string
    • repeats integer
    • engines string[]
    • jobs_total integer
    • jobs_done integer
    • jobs_failed integer
    • created_at string date-time
    • finished_at string date-time

გაზომვის დაწყება

POST/v1/runs

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

რიგში ამატებს ამოცანებს ყველა კომბინაციისთვის: პრომპტი × AI სისტემა × (ენა, მდებარეობა) × გამეორებები.

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • engines string[]
  • repeats integer
  • prompt_ids string[]
    არასავალდებულო: მხოლოდ ამ პრომპტების გაზომვა

პასუხები

  • 201 შეიქმნა

    application/json Run

    • id string
    • brand_id string
    • kind string

      დასაშვები მნიშვნელობები: baseline, scheduled, daily, manual, remeasure

    • status string
    • repeats integer
    • engines string[]
    • jobs_total integer
    • jobs_done integer
    • jobs_failed integer
    • created_at string date-time
    • finished_at string date-time
  • 402 შეცდომა

    application/json Error

გაზომვის მიღება

GET/v1/runs/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Run

    • id string
    • brand_id string
    • kind string

      დასაშვები მნიშვნელობები: baseline, scheduled, daily, manual, remeasure

    • status string
    • repeats integer
    • engines string[]
    • jobs_total integer
    • jobs_done integer
    • jobs_failed integer
    • created_at string date-time
    • finished_at string date-time
  • 404 შეცდომა

    application/json Error

პასუხების დათვალიერება (ფილტრებით, ჯერ უახლესი)

GET/v1/answers

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
run_idquerystring
prompt_idquerystring
mentionedquerystring
მხოლოდ პასუხები, რომლებიც კლიენტს ასახელებს / არ ასახელებს

დასაშვები მნიშვნელობები: yes, no

qquerystring
პასუხის ტექსტში ძებნა, რეგისტრის გაუთვალისწინებლად
limitqueryinteger

ნაგულისხმევი: 50მაქსიმუმ 500

offsetqueryinteger

ნაგულისხმევი: 0

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json object

    • items Answer[]
      ველები: 13
      • id string
      • run_id string
      • prompt_id string
      • prompt string
      • engine string
      • language string
      • location string
      • route string
      • text string
      • citations string[]
      • screenshot_url string
        დარეზერვებული ველი: ჯერ არც ერთი AI სისტემის ადაპტერი ეკრანის ანაბეჭდს არ იღებს, ამიტომ პასუხებში ეს ველი არ არის
      • mentions object[]
        ველები: 5
        • name string
        • is_client boolean
        • position integer
          1 = პასუხში პირველი დასახელებული
        • sentiment number

          −1‑დან 1‑მდე

        • cited_urls string[]
      • created_at string date-time
    • total integer

ხილვადობა კვირების, AI სისტემებისა და ენების მიხედვით

GET/v1/visibility

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json object

    • overall VisRow
      ველები: 8
      • week string
      • engine string
      • language string
      • answers integer
      • mentioned integer
      • visibility_pct number
      • avg_position number
      • avg_sentiment number
    • rows VisRow[]
      ველები: 8
      • week string
      • engine string
      • language string
      • answers integer
      • mentioned integer
      • visibility_pct number
      • avg_position number
      • avg_sentiment number

ხმის წილი კონკურენტებთან შედარებით

GET/v1/share-of-voice

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json SOVRow[]

    • name string
    • is_client boolean
    • mentions integer
    • share_pct number
    • avg_position number
    • avg_sentiment number

დომენები, რომლებსაც AI სისტემები ციტირებენ

GET/v1/citations

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
enginequerystring
languagequerystring
fromquerystring date
toquerystring date
ჩათვლით
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json CitationRow[]

    • domain string
    • count integer
    • share_pct number
    • owner string

      დასაშვები მნიშვნელობები: client, competitor, third_party

ბოლო გაფრთხილებები

GET/v1/alerts

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json object[]

    • id string
    • brand_id string
    • engine string
    • message string
    • created_at string date-time

ბრენდის ყოველკვირეული ანგარიში

GET/v1/report

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Report

    • brand Brand
    • period string
      from – to ტექსტის სახით
    • from string date
      საანგარიშო კვირის პირველი დღე
    • to string date
      საანგარიშო კვირის ბოლო დღე (დღევანდელი დღე, UTC)
    • visibility_pct number
    • visibility_prev_pct number
    • delta_pp number
    • by_engine VisRow[]
    • share_of_voice SOVRow[]
    • top_citations CitationRow[]
    • live_changes integer
    • pending_approval integer
    • experiments Experiment[]
    • recommendations Recommendation[]
    • alerts string[]
    • ai_traffic TrafficRow[]
    • recent_actions Action[]
    • failing_site_checks SiteCheck[]
  • 404 შეცდომა

    application/json Error

ცვლილებები

დიაგნოსტიკა, მომზადებული ცვლილებები, დამტკიცება, ექსპერიმენტები.

ბრენდის დიაგნოსტიკა (საიტის შემოწმება, ხარვეზები, რეკომენდაციები გვერდებისა და ბლოკებისთვის)

POST/v1/diagnose

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო

პასუხები

  • 200 OK

    application/json Recommendation[]

    • id string
    • brand_id string
    • kind string
    • auto_fixable boolean
    • priority integer
      1 = უმაღლესი
    • title string
    • detail string
    • url string
    • created_at string date-time
  • 402 შეცდომა

    application/json Error

მიმდინარე რეკომენდაციები

GET/v1/recommendations

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
auto_fixablequerystring

დასაშვები მნიშვნელობები: true, false

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Recommendation[]

    • id string
    • brand_id string
    • kind string
    • auto_fixable boolean
    • priority integer
      1 = უმაღლესი
    • title string
    • detail string
    • url string
    • created_at string date-time

ცვლილებების მომზადება გვერდისთვის (ფაქტების შემოწმებით)

POST/v1/content/generate

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • url string სავალდებულო
  • language string
  • kinds string[]
    ნაგულისხმევად ყველა; block გვერდის სექციების ბლოკებს ამზადებს

    დასაშვები მნიშვნელობები: answer_block, faq, meta_description, schema, block

პასუხები

  • 201 შემოთავაზებული ცვლილებები

    application/json Content[]

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 400 შეცდომა

    application/json Error

ცვლილებების სია განთავსების ინსტრუქციებითა და ფაქტებით, რომლებსაც ისინი ეყრდნობა

GET/v1/content/items

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
statusquerystring
ერთი სტატუსი ან მძიმით გამოყოფილი სია, მაგ., approved,live (იხ. ContentStatus)
urlquerystring
kindquerystring
ტიპი (answer_block, faq, meta_description, schema, page, gbp_profile, gbp_post, block:<id>) ან block ყველა ბლოკისთვის
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Content[]

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა

ცვლილების მიღება

GET/v1/content/items/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Content

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 404 შეცდომა

    application/json Error

ცვლილების დამტკიცება (სურვილისამებრ — რედაქტირებით)

POST/v1/content/{id}/approve

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

API მიწოდების დამატებითი სერვისის გარეშე საიტის ცვლილებები approved სტატუსს იღებს (მზადაა ხელით განსათავსებლად, placement‑ით; content.approved) და ელოდება POST /v1/content/{id}/applied‑ს. დამატებითი სერვისით კი ისინი მაშინვე live ხდება (მათ GET /v1/content აბრუნებს, იგზავნება content.published, URL IndexNow‑ს ეგზავნება, იწყება ექსპერიმენტი). გვერდები ყოველთვის approved სტატუსს იღებს და ელოდება POST /v1/pages/{id}/published‑ს. Business Profile‑ის ცვლილებები (gbp_profile, gbp_post) Google‑ში ავტომატურად ჩაიწერება ყველა ტარიფზე (ფუნქციის გადამრთველი google_bp). რედაქტირებული ტექსტი უსაფრთხოების ფილტრს ხელახლა გადის.

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი

application/json object

  • სტრუქტურა ცვლილების ტიპზეა დამოკიდებული.
    ველები: 8
    • text string
      answer_block, meta_description
    • sentences Sentence[]
    • faq object[]
      ველები: 3
      • q string
      • a string
      • fact_ids string[]
    • schema object
      JSON-LD
    • block Block
    • page Page
    • profile object
      gbp_profile
      ველები: 4
      • description string

        მაქსიმუმ 750 სიმბოლო

      • phone string
      • website string
      • hours string
        schema.org openingHours, მაგ., Mo-Sa 09:00-20:00, Su 10:00-16:00
    • post object
      gbp_post
      ველები: 2
      • summary string
      • url string

პასუხები

  • 200 OK

    application/json Content

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 400 შეცდომა

    application/json Error

  • 403 შეცდომა

    application/json Error

ცვლილების უარყოფა: განსახილველი, დაბლოკილი ან დამტკიცებული (ჯერ განუთავსებელი)

POST/v1/content/{id}/reject

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Content

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 400 შეცდომა

    application/json Error

საიტზე განთავსებული ცვლილების დაბრუნება

POST/v1/content/{id}/rollback

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

API‑ით ან Business Profile‑ში მიწოდებულ ცვლილებებს PromART თავად მოხსნის (rolled_back). კლიენტის მიერ ხელით განთავსებული ცვლილებები remove_requested სტატუსს იღებს (content.removal_requested) და მასში რჩება, სანამ არ გამოიძახებთ POST /v1/content/{id}/removed‑ს.

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Content

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 400 შეცდომა

    application/json Error

დამტკიცებული ცვლილების მონიშვნა ხელით განთავსებულად

POST/v1/content/{id}/applied

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

კლიენტმა ცვლილება საიტზე ჩასვა. ის live სტატუსს იღებს (delivery: manual), იგზავნება content.published, URL IndexNow‑ს ეგზავნება და იწყება ექსპერიმენტი (ხელახალი გაზომვა, დატოვება ან დაბრუნება). ახალი გვერდებისთვის ამის ნაცვლად გამოიყენება POST /v1/pages/{id}/published.

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Content

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 400 შეცდომა

    application/json Error

  • 404 შეცდომა

    application/json Error

საიტიდან ცვლილების მოხსნის დადასტურება

POST/v1/content/{id}/removed

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

remove_requested სტატუსის ცვლილებებისთვის. ცვლილება rolled_back სტატუსს იღებს, იგზავნება content.rolled_back და URL IndexNow‑ს ეგზავნება.

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Content

    • id string
    • brand_id string
    • url string
      გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
    • kind string
      answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
    • fact_ids string[]
    • technical boolean
    • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

      დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

    • delivery string
      როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

      დასაშვები მნიშვნელობები: api, manual, gbp

    • variant integer
    • verifier_notes string
      რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
    • created_at string date-time
    • published_at string date-time
    • updated_at string date-time
    • placement Placement
    • facts FactRef[]
      დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა
  • 400 შეცდომა

    application/json Error

  • 404 შეცდომა

    application/json Error

ექსპერიმენტები საიტზე განთავსებული ცვლილებებისთვის (მანამდე და შემდეგ)

GET/v1/experiments

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idquerystring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Experiment[]

    • id string
    • brand_id string
    • content_id string
    • url string
    • prompt_ids string[]
    • baseline number
    • baseline_n integer
    • after number
    • after_n integer
    • lift_pp number
    • status string

      დასაშვები მნიშვნელობები: waiting, measuring, kept, rolled_back, inconclusive, cancelled

    • run_id string
    • pickup_at string date-time
    • created_at string date-time
    • decided_at string date-time

ექსპერიმენტის ხელახალი გაზომვა ახლავე

POST/v1/experiments/{id}/measure-now

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 რიგშია

    application/json object

    • queued boolean

ვებჰუკები

ვებჰუკების სია

GET/v1/webhooks

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Webhook[]

    • id string
    • url string
    • events EventType[]

      დასაშვები მნიშვნელობები: *, run.completed, visibility.changed, content.proposed, content.published, content.rolled_back, facts.stale, alert.triggered, page.approved, integration.invited, review.request, content.approved, content.removal_requested

    • secret string
      ბრუნდება შექმნისას; მისით ხელმოწერილია ყოველი გაგზავნა
    • created_at string date-time

მოვლენების გამოწერა URL‑ზე

POST/v1/webhooks

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • url string uri სავალდებულო
  • events EventType[] სავალდებულო

    დასაშვები მნიშვნელობები: *, run.completed, visibility.changed, content.proposed, content.published, content.rolled_back, facts.stale, alert.triggered, page.approved, integration.invited, review.request, content.approved, content.removal_requested

პასუხები

  • 201 შეიქმნა (საიდუმლო გასაღები ამ პასუხშია)

    application/json Webhook

    • id string
    • url string
    • events EventType[]

      დასაშვები მნიშვნელობები: *, run.completed, visibility.changed, content.proposed, content.published, content.rolled_back, facts.stale, alert.triggered, page.approved, integration.invited, review.request, content.approved, content.removal_requested

    • secret string
      ბრუნდება შექმნისას; მისით ხელმოწერილია ყოველი გაგზავნა
    • created_at string date-time
  • 400 შეცდომა

    application/json Error

ვებჰუკის წაშლა

DELETE/v1/webhooks/{id}

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 წაიშალა

    application/json object

    • deleted boolean

ბოლო მოვლენები (იგივე შიგთავსით, რაც ვებჰუკით იგზავნება)

GET/v1/events

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
limitqueryinteger

ნაგულისხმევი: 100მაქსიმუმ 1000

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json object[]

    • id string
    • დასაშვები მნიშვნელობები: *, run.completed, visibility.changed, content.proposed, content.published, content.rolled_back, facts.stale, alert.triggered, page.approved, integration.invited, review.request, content.approved, content.removal_requested

    • payload object
      {id, type, created_at, data}
    • created_at string date-time

შეფასებები

მომხმარებლების კონტაქტების სია

GET/v1/contacts

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json Contact[]

    • id string მხოლოდ წასაკითხი
    • brand_id string
    • name string
    • phone string
    • email string
    • language string
    • source string

      დასაშვები მნიშვნელობები: csv, api, crm

    • opted_out boolean
    • last_requested_at string date-time
    • created_at string date-time

კონტაქტების დამატება (მომხმარებლები, რომლებიც დაკავშირებაზე დათანხმდნენ)

POST/v1/contacts

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • consent boolean სავალდებულო
    უნდა იყოს true
  • contacts Contact[] სავალდებულო
    ველები: 9
    • brand_id string
    • name string
    • phone string
    • email string
    • language string
    • source string

      დასაშვები მნიშვნელობები: csv, api, crm

    • opted_out boolean
    • last_requested_at string date-time
    • created_at string date-time

პასუხები

  • 201 დაემატა

    application/json object

    • added integer
  • 400 შეცდომა

    application/json Error

კონტაქტების იმპორტი CSV ფაილიდან

POST/v1/contacts/import

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

სვეტები: Name, Phone, Email, Language (სათაურების სტრიქონით; UTF-8, BOM დასაშვებია). დუბლიკატები გამოტოვდება.

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
consentqueryსავალდებულოstring

დასაშვები მნიშვნელობები: true

langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

text/csv string

პასუხები

  • 201 იმპორტირებულია

    application/json object

    • rows integer
    • added integer
  • 400 შეცდომა

    application/json Error

კონტაქტის გამორიცხვა შეფასების თხოვნებიდან

POST/v1/contacts/{id}/opt-out

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 204 გამორიცხულია

შეფასების თხოვნების პარამეტრები

GET/v1/reviews/settings

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 OK

    application/json ReviewSettings

    • auto boolean
      ყოველდღიური ავტომატური გაგზავნა ახალი კონტაქტებისთვის
    • review_url string
      ნაგულისხმევად Business Profile‑ის შეფასების ბმული
    • daily_max integer

      ნაგულისხმევი: 50

შეფასების თხოვნების პარამეტრების განახლება

PUT/v1/reviews/settings

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

პარამეტრები

პარამეტრიტიპი და აღწერა
brand_idqueryსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json ReviewSettings

  • auto boolean
    ყოველდღიური ავტომატური გაგზავნა ახალი კონტაქტებისთვის
  • review_url string
    ნაგულისხმევად Business Profile‑ის შეფასების ბმული
  • daily_max integer

    ნაგულისხმევი: 50

პასუხები

  • 200 OK

    application/json ReviewSettings

    • auto boolean
      ყოველდღიური ავტომატური გაგზავნა ახალი კონტაქტებისთვის
    • review_url string
      ნაგულისხმევად Business Profile‑ის შეფასების ბმული
    • daily_max integer

      ნაგულისხმევი: 50

შეფასების თხოვნის გაგზავნა შესაბამისი მომხმარებლებისთვის

POST/v1/review-requests

ავტორიზაცია: Bearer ტოკენი, API გასაღები (sk_live_…) ან პანელის სესია (sess_…)

შესაბამისია მომხმარებელი, რომელიც გამორიცხული არ არის და ბოლო 180 დღეში თხოვნა არ მიუღია. თითოეული თხოვნა თქვენს შეტყობინებების სისტემას review.request ვებჰუკით ეგზავნება; dry_run რეჟიმში მხოლოდ შეტყობინებები ბრუნდება.

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • brand_id string სავალდებულო
  • max integer
  • dry_run boolean

პასუხები

  • 200 თხოვნები

    application/json object[]

    • contact_id string
    • name string
    • phone string
    • email string
    • language string
    • message string
  • 400 შეცდომა

    application/json Error

საჯარო

API გასაღების გარეშე. OAuth‑ის დაბრუნების მისამართი, მოსაწვევი გვერდები და მათი შრიფტები, რეგისტრაცია, პანელში შესვლა, დოკუმენტაცია.

სერვერის მდგომარეობის შემოწმება

GET/healthz

ავტორიზაციის გარეშე

პასუხები

  • 200 OK

    application/json object

    • status string

      დასაშვები მნიშვნელობები: ok

ეს OpenAPI დოკუმენტი

GET/openapi.yaml

ავტორიზაციის გარეშე

პასუხები

  • 200 OpenAPI 3.1 YAML

    application/yaml string

API დოკუმენტაცია (ეს გვერდი)

GET/docs

ავტორიზაციის გარეშე

ეს დოკუმენტაცია ერთი HTML გვერდია: სერვერი მას ამ OpenAPI დოკუმენტის მიხედვით აგებს და ის JavaScript‑ის გარეშეც სრულად ჩანს. ჯერ სახელმძღვანელოა, შემდეგ — ყველა მეთოდი პარამეტრებით, მოთხოვნის შიგთავსით, პასუხებით, კოდის ნიმუშებითა და მაგალითებით. გვერდის ინტერფეისი და OpenAPI დოკუმენტის ტექსტები მოთხოვნის ენაზეა (lang, თუ არ არის — Accept-Language, თუ არც ეს — ინგლისური); ტექსტი, რომელსაც თარგმანი არ აქვს, ინგლისურად ჩანს.

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 HTML

    სათაურები

    • Content-Language string
      ამ პასუხის ტექსტების ენა: lang პარამეტრი, თუ არ არის — Accept-Language‑იდან საუკეთესო მხარდაჭერილი ენა, თუ არც ეს — en (/openapi.yaml‑ისთვის ყოველთვის en)

    text/html string

  • 304 არ შეცვლილა (If-None-Match)

დოკუმენტაციის გვერდის სტილების ფაილი, სკრიპტი და შრიფტები

GET/docs/assets/{file}

ავტორიზაციის გარეშე

docs.css, docs.js და ვებშრიფტები, რომლებსაც გვერდი იყენებს: Sachino Sans (FiraGO‑ს ქვენაკრებები, ლიცენზია — OFL-FiraGO.txt) 400, 500 და 600 სისქით ლათინური, ქართული და კირილური დამწერლობისთვის, ასევე Fira Code (OFL-FiraCode.txt). გვერდის ბმულებში თითოეულ ფაილს შიგთავსის ჰეში ახლავს (?v=); მიმდინარე ჰეშით მოთხოვნილი ფაილი ერთი წლით ქეშირდება (immutable).

პარამეტრები

პარამეტრიტიპი და აღწერა
filepathსავალდებულოstring

მაგალითი: docs.css

vquerystring
ფაილის შიგთავსის ჰეში, როგორც ის გვერდის ბმულშია მითითებული

პასუხები

  • 200 ფაილი (text/css, text/javascript, font/woff2 ან, ლიცენზიისთვის, text/plain)

    text/css string

  • 304 არ შეცვლილა (If-None-Match)
  • 404 ასეთი ფაილი არ არსებობს

მოსაწვევი გვერდის ვებშრიფტები

GET/assets/fonts/{file}

ავტორიზაციის გარეშე

Sachino Sans (FiraGO‑ს ქვენაკრებები, SIL Open Font License; ლიცენზია — OFL.txt) 400 და 600 სისქით ლათინური, ქართული და კირილური დამწერლობისთვის, მაგ., sachino-sans-400-georgian.woff2. ქეშირდება ერთი წლით (immutable); გვერდების ბმულებში შიგთავსის ჰეში ?v= პარამეტრითაა მითითებული.

პარამეტრები

პარამეტრიტიპი და აღწერა
filepathსავალდებულოstring

მაგალითი: sachino-sans-400-latin.woff2

პასუხები

  • 200 ფაილი (font/woff2, ლიცენზიისთვის — text/plain)

    font/woff2 string binary

  • 304 არ შეცვლილა (If-None-Match)
  • 404 ასეთი ფაილი არ არსებობს

მოსაწვევი გვერდის ვებშრიფტები (/connect/ პრეფიქსით)

GET/connect/assets/fonts/{file}

ავტორიზაციის გარეშე

Sachino Sans (FiraGO‑ს ქვენაკრებები, SIL Open Font License; ლიცენზია — OFL.txt) 400 და 600 სისქით ლათინური, ქართული და კირილური დამწერლობისთვის, მაგ., sachino-sans-400-georgian.woff2. ქეშირდება ერთი წლით (immutable); გვერდების ბმულებში შიგთავსის ჰეში ?v= პარამეტრითაა მითითებული. მოსაწვევი გვერდი სწორედ ამ ასლს იყენებს, /connect/ პრეფიქსით, რომლის მოთხოვნებს პროქსი სერვერები API‑ს გადასცემს; ფაილები იგივეა, რაც /assets/fonts/‑ში.

პარამეტრები

პარამეტრიტიპი და აღწერა
filepathსავალდებულოstring

მაგალითი: sachino-sans-400-latin.woff2

პასუხები

  • 200 ფაილი (font/woff2, ლიცენზიისთვის — text/plain)

    font/woff2 string binary

  • 304 არ შეცვლილა (If-None-Match)
  • 404 ასეთი ფაილი არ არსებობს

უფასო აუდიტის სამუშაო სივრცის შექმნა

POST/v1/signup

ავტორიზაციის გარეშე

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • name string სავალდებულო

პასუხები

  • 201 შეიქმნა; API გასაღები ახლავე შეინახეთ: ის მეორედ აღარ გამოჩნდება

    application/json object

    • workspace Workspace
    • api_key string
    • note string
  • 400 შეცდომა

    application/json Error

პანელში შესვლა (API გასაღები → სესიის ტოკენი)

POST/v1/sessions

ავტორიზაციის გარეშე

სამუშაო სივრცის API გასაღებს ცვლის პანელის სესიის sess_… ტოკენზე, რომელიც 30 დღე მოქმედებს. სესიები ყველა ტარიფზე მუშაობს.

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • api_key string სავალდებულო

პასუხები

  • 201 სესია შეიქმნა

    application/json object

    • token string
    • workspace Workspace
      ველები: 8
      • id string
      • name string
      • plan string
      • parent_id string
      • auto_publish_technical boolean
        ტექნიკური ცვლილებების ავტომატური განთავსება (საჭიროა API მიწოდების დამატებითი სერვისი)
      • api_delivery_enabled boolean
        API მიწოდების ფასიანი დამატებითი სერვისი
      • auto_fixes boolean
        ცვლილებები ავტომატურად მზადდება ყოველი დიაგნოსტიკის შემდეგ. გამორთული = მხოლოდ ანალიტიკა, ცვლილებები მოთხოვნით.
      • created_at string date-time
  • 400 შეცდომა

    application/json Error

  • 401 შეცდომა

    application/json Error

ტარიფები და ლიმიტები

GET/v1/plans

ავტორიზაციის გარეშე

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 ტარიფების ობიექტი: გასაღები — ტარიფის სახელი

    application/json map<string, Plan>

    • name string
    • price_gel integer
    • prompts integer
    • engines integer
    • brands integer
    • competitors integer
    • languages integer
    • answers_per_month integer
    • interval string
    • daily_prompts integer
    • diagnosis boolean
    • autopilot boolean
    • child_workspaces integer
    • overage string

      დასაშვები მნიშვნელობები: block, bill

    • rate_limit_rps number
    • api_access boolean
      API გასაღებებით API‑ის გამოძახება შესაძლებელია (პანელი ყველა ტარიფზე მუშაობს)

Google OAuth‑ის დაბრუნების URL

GET/v1/oauth/google/callback

ავტორიზაციის გარეშე

თანხმობის შემდეგ Google მომხმარებელს აქ გადმოამისამართებს. PromART კოდს ტოკენებზე ცვლის, პოულობს შესაბამის მდებარეობას/საიტს/რესურსს და ბრაუზერს პანელზე გადაამისამართებს (/#/integrations?kind=&status=).

პარამეტრები

პარამეტრიტიპი და აღწერა
codequerystring
statequeryსავალდებულოstring
HMAC‑ით ხელმოწერილი, მოქმედებს 30 წუთი
errorquerystring

პასუხები

  • 302 გადამისამართება პანელზე

მოსაწვევი გვერდი იმისთვის, ვინც ანგარიშს მართავს

GET/connect/{token}

ავტორიზაციის გარეშე

HTML გვერდი Google‑ის ღილაკით ან Cloudflare‑ის ტოკენის ფორმით, მოთხოვნის ენაზე (lang, თუ არ არის — Accept-Language, თუ არც ეს — ინგლისური) და დანარჩენ ორ ენაზე გვერდის ბმულებით. დაკავშირების ტექსტი იგივეა, რაც GET /v1/integrations‑ის wording.

პარამეტრები

პარამეტრიტიპი და აღწერა
tokenpathსავალდებულოstring
ერთჯერადი მოსაწვევი ტოკენი (მოქმედებს 14 დღე)
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 200 HTML

    text/html string

  • 404 არასწორი, უკვე გამოყენებული ან ვადაგასული ბმული (HTML)

Cloudflare‑ის დაკავშირება მოსაწვევიდან

POST/connect/{token}

ავტორიზაციის გარეშე

პარამეტრები

პარამეტრიტიპი და აღწერა
tokenpathსავალდებულოstring
ერთჯერადი მოსაწვევი ტოკენი (მოქმედებს 14 დღე)
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/x-www-form-urlencoded object

  • token string სავალდებულო
    Cloudflare‑ის API ტოკენი

პასუხები

  • 200 დაკავშირებულია (HTML)
  • 400 შეცდომა (HTML): ფორმა ხელახლა, მიზეზის მითითებით, ან ვადაგასული ბმულის გვერდი

Google‑ის თანხმობის დაწყება მოსაწვევიდან

GET/connect/{token}/google

ავტორიზაციის გარეშე

პარამეტრები

პარამეტრიტიპი და აღწერა
tokenpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

პასუხები

  • 302 გადამისამართება Google‑ის თანხმობის გვერდზე
  • 400 შეცდომა (HTML)

ადმინისტრირება

ოპერატორის მეთოდები, X-Admin-Token სათაურით.

სამუშაო სივრცის შექმნა ნებისმიერ ტარიფზე

POST/v1/admin/workspaces

ავტორიზაცია: ოპერატორის ტოკენი X-Admin-Token სათაურში

პარამეტრები

პარამეტრიტიპი და აღწერა
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • name string სავალდებულო
  • plan string

    ნაგულისხმევი: optimize

  • parent_id string

პასუხები

  • 201 შეიქმნა; API გასაღები ახლავე შეინახეთ: ის მეორედ აღარ გამოჩნდება

    application/json object

    • workspace Workspace
    • api_key string
    • note string
  • 401 შეცდომა

    application/json Error

სამუშაო სივრცის ტარიფის შეცვლა ან API მიწოდების ჩართვა/გამორთვა

PATCH/v1/admin/workspaces/{id}

ავტორიზაცია: ოპერატორის ტოკენი X-Admin-Token სათაურში

პარამეტრები

პარამეტრიტიპი და აღწერა
idpathსავალდებულოstring
langqueryAccept-Languageheader
პასუხის ტექსტების ენა: ka, ru ან en. იხ. ენა

მოთხოვნის შიგთავსი სავალდებულო

application/json object

  • plan string
  • api_delivery_enabled boolean
    API მიწოდების ფასიანი დამატებითი სერვისის ჩართვა ან გამორთვა

პასუხები

  • 200 სამუშაო სივრცე

    application/json Workspace

    • id string
    • name string
    • plan string
    • parent_id string
    • auto_publish_technical boolean
      ტექნიკური ცვლილებების ავტომატური განთავსება (საჭიროა API მიწოდების დამატებითი სერვისი)
    • api_delivery_enabled boolean
      API მიწოდების ფასიანი დამატებითი სერვისი
    • auto_fixes boolean
      ცვლილებები ავტომატურად მზადდება ყოველი დიაგნოსტიკის შემდეგ. გამორთული = მხოლოდ ანალიტიკა, ცვლილებები მოთხოვნით.
    • created_at string date-time
  • 401 შეცდომა

    application/json Error

  • 404 შეცდომა

    application/json Error

სქემები

ობიექტები, რომლებსაც მეთოდები იღებს და აბრუნებს; თითოეული აქ ერთხელაა აღწერილი. მეთოდთან ჩანს მისი მოთხოვნისა და პასუხის ველები, დანარჩენს კი ბმულით აქ ნახავთ.

Error object

  • error object
    ველები: 4
    • code string

      დასაშვები მნიშვნელობები: unauthorized, plan_limit, api_access_required, addon_required, feature_disabled, not_found, invalid_request, invalid_json, rate_limited, internal

    • message string
      ადამიანისთვის გასაგები ტექსტი; პასუხის ენაზე, თუ reason მითითებულია, სხვა შემთხვევაში — ინგლისურად
    • reason string
      კონკრეტული მიზეზი: შეტყობინების სტაბილური გასაღები, მაგ., http.err.brand_id_required ან core.err.not_found.brand (მხოლოდ იმ შეცდომებში, რომლებსაც ის აქვს)
    • params object
      შეტყობინებაში ჩასმული მნიშვნელობები, ფორმატირების გარეშე; ტარიფი, სტატუსი ან AI სისტემა მისი კოდით არის მოცემული (მხოლოდ reason‑თან ერთად და მხოლოდ მაშინ, როცა მნიშვნელობები არსებობს)

Workspace object

  • id string
  • name string
  • plan string
  • parent_id string
  • auto_publish_technical boolean
    ტექნიკური ცვლილებების ავტომატური განთავსება (საჭიროა API მიწოდების დამატებითი სერვისი)
  • api_delivery_enabled boolean
    API მიწოდების ფასიანი დამატებითი სერვისი
  • auto_fixes boolean
    ცვლილებები ავტომატურად მზადდება ყოველი დიაგნოსტიკის შემდეგ. გამორთული = მხოლოდ ანალიტიკა, ცვლილებები მოთხოვნით.
  • created_at string date-time

Plan object

  • name string
  • price_gel integer
  • prompts integer
  • engines integer
  • brands integer
  • competitors integer
  • languages integer
  • answers_per_month integer
  • interval string
  • daily_prompts integer
  • diagnosis boolean
  • autopilot boolean
  • child_workspaces integer
  • overage string

    დასაშვები მნიშვნელობები: block, bill

  • rate_limit_rps number
  • api_access boolean
    API გასაღებებით API‑ის გამოძახება შესაძლებელია (პანელი ყველა ტარიფზე მუშაობს)

Usage object

  • plan Plan
  • month string
  • answers integer
  • queued_jobs integer
  • prompts integer
  • brands integer
  • overage_answers integer
  • child_workspaces integer
  • add_ons object[]
    ველები: 4
    • name string
    • title string
    • description string
    • enabled boolean

Competitor object

  • name string
  • variants string[]
  • domain string

Brand object

  • id string მხოლოდ წასაკითხი
  • name string
  • domain string
  • industry string
  • city string
  • variants string[]
    სახელის სხვა ვარიანტები (მაგ., ქართულად, რუსულად)
  • competitors Competitor[]
  • languages string[]
  • markets string[]
  • engines string[]
  • channel string
    api: თქვენი საიტის სერვერი PromART‑ის API‑ს მიმართავს; gbp: მხოლოდ Business Profile

    დასაშვები მნიშვნელობები: api, gbp

  • created_at string date-time მხოლოდ წასაკითხი

Fact object

  • id string მხოლოდ წასაკითხი
  • brand_id string
  • key string
  • value string
  • lang string
    ენის კოდი ან any
  • url string
  • source string

    დასაშვები მნიშვნელობები: api, form, extracted

  • status string

    დასაშვები მნიშვნელობები: confirmed, unconfirmed

  • updated_at string date-time მხოლოდ წასაკითხი

Prompt object

  • id string მხოლოდ წასაკითხი
  • brand_id string
  • text string
  • language string
  • market string
  • target_url string
  • active boolean
  • created_at string date-time მხოლოდ წასაკითხი

Run object

  • id string
  • brand_id string
  • kind string

    დასაშვები მნიშვნელობები: baseline, scheduled, daily, manual, remeasure

  • status string
  • repeats integer
  • engines string[]
  • jobs_total integer
  • jobs_done integer
  • jobs_failed integer
  • created_at string date-time
  • finished_at string date-time

Answer object

  • id string
  • run_id string
  • prompt_id string
  • prompt string
  • engine string
  • language string
  • location string
  • route string
  • text string
  • citations string[]
  • screenshot_url string
    დარეზერვებული ველი: ჯერ არც ერთი AI სისტემის ადაპტერი ეკრანის ანაბეჭდს არ იღებს, ამიტომ პასუხებში ეს ველი არ არის
  • mentions object[]
    ველები: 5
    • name string
    • is_client boolean
    • position integer
      1 = პასუხში პირველი დასახელებული
    • sentiment number

      −1‑დან 1‑მდე

    • cited_urls string[]
  • created_at string date-time

VisRow object

  • week string
  • engine string
  • language string
  • answers integer
  • mentioned integer
  • visibility_pct number
  • avg_position number
  • avg_sentiment number

SOVRow object

  • name string
  • is_client boolean
  • mentions integer
  • share_pct number
  • avg_position number
  • avg_sentiment number

CitationRow object

  • domain string
  • count integer
  • share_pct number
  • owner string

    დასაშვები მნიშვნელობები: client, competitor, third_party

Recommendation object

  • id string
  • brand_id string
  • kind string
  • auto_fixable boolean
  • priority integer
    1 = უმაღლესი
  • title string
  • detail string
  • url string
  • created_at string date-time

Experiment object

  • id string
  • brand_id string
  • content_id string
  • url string
  • prompt_ids string[]
  • baseline number
  • baseline_n integer
  • after number
  • after_n integer
  • lift_pp number
  • status string

    დასაშვები მნიშვნელობები: waiting, measuring, kept, rolled_back, inconclusive, cancelled

  • run_id string
  • pickup_at string date-time
  • created_at string date-time
  • decided_at string date-time

TrafficRow object

  • source string
  • sessions integer
  • from string date
  • to string date

Report object

  • brand Brand
  • period string
    from – to ტექსტის სახით
  • from string date
    საანგარიშო კვირის პირველი დღე
  • to string date
    საანგარიშო კვირის ბოლო დღე (დღევანდელი დღე, UTC)
  • visibility_pct number
  • visibility_prev_pct number
  • delta_pp number
  • by_engine VisRow[]
  • share_of_voice SOVRow[]
  • top_citations CitationRow[]
  • live_changes integer
  • pending_approval integer
  • experiments Experiment[]
  • recommendations Recommendation[]
  • alerts string[]
  • ai_traffic TrafficRow[]
  • recent_actions Action[]
  • failing_site_checks SiteCheck[]

ContentStatus string

approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

Sentence object

  • text string
  • fact_ids string[]

Block object

  • block_id string
  • selector string
    CSS სელექტორი; გამოიყენეთ პირველ შესაბამის ელემენტზე
  • action string

    დასაშვები მნიშვნელობები: replace, append, prepend, before, after

  • html string
    გასუფთავებული HTML

Page object

  • url string
    შემოთავაზებული URL; POST /v1/pages/{id}/published‑ის შემდეგ იცვლება რეალურით
  • title string
  • language string
  • topic string
  • sections object[]
    ველები: 3
    • heading string
    • html string
      გასუფთავებული HTML (აბზაცები, სიები, ცხრილები)
    • sentences Sentence[]
  • schema object
    JSON-LD, რომელიც script type=application/ld+json ელემენტში უნდა ჩაისვას
  • internal_links object[]
    ველები: 2
    • url string
    • text string

ContentBody object

სტრუქტურა ცვლილების ტიპზეა დამოკიდებული.
  • text string
    answer_block, meta_description
  • sentences Sentence[]
  • faq object[]
    ველები: 3
    • q string
    • a string
    • fact_ids string[]
  • schema object
    JSON-LD
  • block Block
  • page Page
  • profile object
    gbp_profile
    ველები: 4
    • description string

      მაქსიმუმ 750 სიმბოლო

    • phone string
    • website string
    • hours string
      schema.org openingHours, მაგ., Mo-Sa 09:00-20:00, Su 10:00-16:00
  • post object
    gbp_post
    ველები: 2
    • summary string
    • url string

Content object

  • id string
  • brand_id string
  • url string
    გვერდის URL ან gbp://<domain> Business Profile‑ის ცვლილებებისთვის
  • kind string
    answer_block | faq | meta_description | schema | block:<id> | page | gbp_profile | gbp_post
  • fact_ids string[]
  • technical boolean
  • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

    დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

  • delivery string
    როგორ მიეწოდა საიტზე განთავსებული ცვლილება კლიენტს

    დასაშვები მნიშვნელობები: api, manual, gbp

  • variant integer
  • verifier_notes string
    რატომ დაბლოკა შემოწმებებმა ცვლილება (ან შენიშვნა, რომ ის დამტკიცებამდე დარედაქტირდა), პასუხის ენაზე (იხ. „ენა“). ინგლისურად: „sanitizer: <reason>“, „verifier: <JSON list of reasons>“ ან „edited by client before approval“.
  • created_at string date-time
  • published_at string date-time
  • updated_at string date-time
  • placement Placement
  • facts FactRef[]
    დადასტურებული ფაქტები, რომლებსაც ცვლილება ეყრდნობა

Placement object

სად და როგორ უნდა განთავსდეს ცვლილება ხელით. where, steps და ნაწილების წარწერები პასუხის ენაზეა (იხ. „ენა“); ნაწილების მნიშვნელობები თავად საიტის შიგთავსია და არასოდეს ითარგმნება.
  • url string
  • where string
  • steps string[]
  • current string
    ჩასანაცვლებელი ტექსტი, როგორც PromART‑მა ბოლოს წაიკითხა (replace ბლოკებისთვის)
  • parts CopyPart[]

CopyPart object

  • label string
  • format string

    დასაშვები მნიშვნელობები: text, html, json-ld, head-html

  • value string

FactRef object

  • id string
  • key string
  • value string
  • lang string

KPI object

  • answers integer
  • mentioned integer
  • visibility_pct number
  • sov_pct number
  • avg_position number
    ნაკლები ჯობია
  • avg_sentiment number

    −1‑დან 1‑მდე

Overview object

  • from string date
  • to string date
  • prev_from string date
  • prev_to string date
  • current KPI
  • previous KPI

TrendRow object

  • week string date
    კვირის ორშაბათი
  • key string
    AI სისტემა, ენა, ბრენდის სახელი ან all
  • is_client boolean
  • answers integer
  • mentioned integer
  • visibility_pct number
  • sov_pct number
  • avg_position number
  • avg_sentiment number

CompetitorRow object

  • name string
  • is_client boolean
  • mentions integer
  • visibility_pct number
  • sov_pct number
  • avg_position number
  • avg_sentiment number
  • prev_visibility_pct number
  • prev_sov_pct number

SourceRow object

  • url string
    მხოლოდ by=url პარამეტრით
  • domain string
  • owner string

    დასაშვები მნიშვნელობები: client, competitor, third_party

  • count integer
    მციტირებელი პასუხების რაოდენობა
  • share_pct number
  • engines map<string, integer>

EngineCell object

  • answers integer
  • visibility_pct number
  • avg_position number

PromptRow object

  • prompt_id string
  • text string
  • language string
  • target_url string
  • answers integer
  • visibility_pct number
  • avg_position number
  • top_competitor string
  • engines map<string, EngineCell>

BlockItem object

  • content_id string
  • block_id string
  • selector string
  • action string

    დასაშვები მნიშვნელობები: replace, append, prepend, before, after

  • html string
  • fact_ids string[]
  • approved = მზადაა ხელით განსათავსებლად; remove_requested = დაბრუნებულია და ელოდება, რომ კლიენტმა ის საიტიდან მოხსნას

    დასაშვები მნიშვნელობები: proposed, approved, live, remove_requested, rolled_back, rejected, superseded, stale, blocked

Delivery object

  • url string
  • version integer
    იზრდება ამ URL‑ის ყოველი გამოქვეყნებული ცვლილებისას
  • meta_description string
  • answer_block string
  • faq object[]
    ველები: 3
    • q string
    • a string
    • fact_ids string[]
  • schema object
    JSON-LD
  • blocks BlockItem[]
  • content_ids string[]
  • signature string
    მოძველებული ველი: შიგთავსის HMAC ამ ველის გარეშე. ამის ნაცვლად შეამოწმეთ X-Sachino-Signature სათაური.

SiteCheck object

  • id string
  • check string

    დასაშვები მნიშვნელობები: robots_ai_bots, cdn_ai_bots, sitemap, indexnow_key, fetch, noindex, js_rendering, speed, google_index

  • target string
    დომენი ან URL
  • status string

    დასაშვები მნიშვნელობები: ok, warn, fail, unknown

  • detail string
  • instruction string
    ზუსტი დავალება კლიენტისთვის ან დეველოპერისთვის
  • fix string
    ავტომატური გამოსწორება, რომლის შესრულებაც PromART‑ს შეუძლია, მაგ., cloudflare:allow_ai_crawlers
  • source string

    დასაშვები მნიშვნელობები: crawl, gsc, cloudflare

  • checked_at string date-time

IndexNowInfo object

  • key string
  • files object[]
    ველები: 5
    • brand_id string
    • domain string
    • url string
      https://<domain>/<key>.txt
    • content string
      ფაილის ზუსტი შიგთავსი (გასაღები)
    • status string
      საიტის ბოლო შემოწმების შედეგი

      დასაშვები მნიშვნელობები: ok, fail, unknown

  • instructions string[]

Integration object

  • id string
  • brand_id string
  • kind string

    დასაშვები მნიშვნელობები: google_bp, gsc, ga4, cloudflare

  • status string

    დასაშვები მნიშვნელობები: invited, pending, connected, needs_selection, error, revoked

  • account string
  • scopes string
  • config map<string, string>
  • invite_email string
  • last_sync_at string date-time
  • last_error string
  • created_at string date-time
  • updated_at string date-time

IntegrationKind object

  • scope string
    Google OAuth‑ის წვდომის არე
  • access string
  • does string
  • enabled boolean
    false, როცა სერვერზე ფუნქციის გადამრთველი გამორთულია

ConnectResult object

  • integration Integration
  • auth_url string
    Google‑ის თანხმობის გვერდი
  • invite_url string
    ერთჯერადი ბმული იმისთვის, ვინც ანგარიშს მართავს
  • note string

Action object

  • id string
  • brand_id string
  • channel string

    დასაშვები მნიშვნელობები: site, gbp, gsc, bing, cloudflare, reviews

  • kind string
  • target string
  • summary string
  • content_id string
  • integration_id string
  • before any
    წინა მნიშვნელობა (თუ ცნობილია)
  • after any
    ახალი მნიშვნელობა
  • status string

    დასაშვები მნიშვნელობები: done, failed, rolled_back

  • error string
  • rollback_url string
    გასაუქმებლად გააგზავნეთ POST მოთხოვნა ამ მისამართზე (მხოლოდ შექცევადი ქმედებებისთვის)
  • created_at string date-time
  • rolled_back_at string date-time

Contact object

  • id string მხოლოდ წასაკითხი
  • brand_id string
  • name string
  • phone string
  • email string
  • language string
  • source string

    დასაშვები მნიშვნელობები: csv, api, crm

  • opted_out boolean
  • last_requested_at string date-time
  • created_at string date-time

ReviewSettings object

  • auto boolean
    ყოველდღიური ავტომატური გაგზავნა ახალი კონტაქტებისთვის
  • review_url string
    ნაგულისხმევად Business Profile‑ის შეფასების ბმული
  • daily_max integer

    ნაგულისხმევი: 50

EventType string

დასაშვები მნიშვნელობები: *, run.completed, visibility.changed, content.proposed, content.published, content.rolled_back, facts.stale, alert.triggered, page.approved, integration.invited, review.request, content.approved, content.removal_requested

Webhook object

  • id string
  • url string
  • events EventType[]

    დასაშვები მნიშვნელობები: *, run.completed, visibility.changed, content.proposed, content.published, content.rolled_back, facts.stale, alert.triggered, page.approved, integration.invited, review.request, content.approved, content.removal_requested

  • secret string
    ბრუნდება შექმნისას; მისით ხელმოწერილია ყოველი გაგზავნა
  • created_at string date-time