Pozostałe: lista grup (`list`)

GET/api/rank_tracker/management/groups/list

Zwraca grupy fraz kluczowych zdefiniowane w projekcie Rank Tracker wraz z podstawowymi metadanymi każdej grupy (id, name, is_dynamic, keywords_number). Odpowiedź jest opakowana w kopertę z paginacją (pagination).

Nazwa	ID grupy	Dynamiczna	Liczba fraz
eee	21423	0	0

limit 2 — grupy fraz zdefiniowane w projekcie Rank Tracker. Wszystkie adresowalne pola wiersza.

Żądanie

GET /api/rank_tracker/management/groups/list

Nagłówki: Authorization: Bearer <token>. Parametry przekazuj w query stringu (np. ?project_id=87913&limit=2&page=1) — przekazanie ich w body żądania zostanie zignorowane i zwróci 418.

Struktura żądania

Podstawowy

żądanie-podstawowe.jsonc


{
  "project_id": null
}

Rozszerzony

żądanie-rozszerzone.jsonc


{
  "project_id": null,
  "limit": 2,
  "page": 1
}

cURL


curl --location --request GET 'https://api.senuto.com/api/rank_tracker/management/groups/list?project_id=87913&limit=2&page=1' \
  --header 'Authorization: Bearer $YOUR_TOKEN_HERE'

Parametry

Name	Type	Default
`project_id`	`number` Wymagane. ID projektu Rank Tracker. Użytkownik musi mieć dostęp do projektu (właściciel, admin lub udostępnienie ACL); w przeciwnym razie `418` `Unauthorized access`. Realny `project_id` pobierzesz z `POST /api/rank_tracker/management/projects/getMyActiveProjects`.
`limit`	`number` Liczba grup na stronę (paginacja). Nieujemna liczba całkowita. Gdy pominięte, zwracane są wszystkie grupy (`pagination.limit = null`).
`page`	`number` Numer strony (paginacja). Nieujemna liczba całkowita.	`1`

Ten endpoint używa metody GET — parametry należy przekazywać w query stringu (kontroler odczytuje getQuery(), a nie getData()). Żądanie POST z parametrami w body zwraca 418 invalid_data (params.project_id._required = "This field is required"), ponieważ body jest ignorowane. Wymagany jest wyłącznie project_id; brak dostępu do projektu również skutkuje 418 (Unauthorized access).

Odpowiedź

Po pomyślnym żądaniu otrzymujesz data (płaską tablicę grup) oraz pagination.

Skrócona

przykładowa-odpowiedź (skrócona)


{
  "success": true,
  "data": [
    { "id": 21423, "name": "eee", "is_dynamic": 0, "keywords_number": 0 }
  ],
  "pagination": { "page_count": 1, "current_page": 1, "has_next_page": false, "has_prev_page": false, "count": 1, "limit": 2 }
}

Struktura odpowiedzi

Name	Type	Default
`success`	`boolean` `true` przy powodzeniu; przy błędzie `false` i koperta z `error`
`data`	`Group[]` Zwrócone grupy fraz kluczowych
`pagination`	`{ page_count: number; current_page: number; has_next_page: boolean; has_prev_page: boolean; count: number; limit: number \| null; }` Metadane paginacji

Błędy

Name	Type	Default
`success`	`false`
`data`	`{ error: { type: string; message: string; params?: Record<string, Record<string, string>>; }; }`

418 jest zwracane również w przypadku błędów walidacji — nie tylko przy ograniczaniu liczby żądań. Brak project_id (lub przekazanie parametrów w body zamiast w query stringu) → {"success":false,"data":{"error":{"type":"invalid_data","params":{"project_id":{"_required":"This field is required"}}}}}. Brak dostępu do wskazanego projektu → 418 z komunikatem Unauthorized access.

Powiązane akcje

list — lista grup z paginacją (ta strona)
get — pojedyncza grupa po group_id (operacja odczytu, czyta group_id z query stringu; is_dynamic jako boolean + pole filtering)
create / createDynamic — utworzenie grupy statycznej / dynamicznej (POST, body przez getData)
edit / editDynamic — edycja grupy statycznej / dynamicznej (POST, body przez getData)
delete — usunięcie grupy (POST, body przez getData)

Pozostałe: lista grup (list)