# Ikhtisar Peringkat Historis

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live`

**Tags:** DataForSEO

Ikhtisar peringkat sebuah domain sebagaimana adanya pada setiap titik dalam riwayat yang tersedia. Endpoint ini tidak menerima parameter batas, tetapi ditagih per panggilan, bukan per item, jadi kirim seluruh daftar sekaligus. Dibungkus dalam envelope DataForSEO: data ada di `tasks[0].result`, hasil di `tasks[0].status_code` - permintaan yang ditolak tetap mengembalikan HTTP 200. Periksa `get_dataforseo_labs_google_available_history` terlebih dahulu - ini menyebutkan tanggal yang ada, dan meminta tanggal di luarnya tidak mengembalikan apa pun, bukan kesalahan. Snapshot saat ini adalah `post_dataforseo_labs_google_domain_rank_overview_live`.

### Referensi harga

- Pengukuran: biaya respons yang dilaporkan.
- Perkiraan referensi per permintaan: USD 0,1356.
- Pengali referensi pelanggan: 1,0. Jangan menerapkannya lagi pada jumlah tagihan pelanggan yang telah diselesaikan.

Hanya metadata referensi, bukan penawaran akun, harga yang dijamin, atau batas pengeluaran. Kredit sumber daya bukan kredit Felo. Biaya akhir mengikuti catatan penagihan Felo.

## Related links

- [artikel pusat bantuan](<https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them>)
- [artikel pusat bantuan ini](<https://dataforseo.com/help-center/how-is-etv-calculated>)
- [artikel pusat bantuan ini](<https://dataforseo.com/help-center/how-is-traffic-cost-calculated>)
- [artikel pusat bantuan ini](<https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated>)

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "target": {
            "type": "string",
            "description": "<em>domain</em><br><strong>field wajib</strong><br>nama domain situs web target<br>domain harus ditentukan tanpa <code>https://</code> dan <code>www.</code>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>nama lengkap lokasi</em><br><strong>field wajib jika Anda tidak menentukan</strong> <code>location_code</code><br><strong>Catatan:</strong> Anda harus menentukan <code>location_name</code> atau <code>location_code</code><br>Anda dapat memperoleh daftar lokasi yang tersedia beserta <code>location_name</code>-nya dengan membuat permintaan terpisah ke <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>contoh:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>kode lokasi</em><br><strong>field wajib jika Anda tidak menentukan</strong> <code>location_name</code><br><strong>Catatan:</strong> Anda harus menentukan <code>location_name</code> atau <code>location_code</code><br>Anda dapat memperoleh daftar lokasi yang tersedia beserta <code>location_code</code>-nya dengan membuat permintaan terpisah ke <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>contoh:<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>nama lengkap bahasa</em><br><strong>field wajib jika Anda tidak menentukan</strong> <code>language_code</code><br><strong>Catatan:</strong> Anda harus menentukan <code>language_name</code> atau <code>language_code</code><br>Anda dapat memperoleh daftar lokasi yang tersedia beserta <code>language_name</code>-nya dengan membuat permintaan terpisah ke <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>contoh:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>kode bahasa</em><br><strong>field wajib jika Anda tidak menentukan</strong> <code>language_name</code><br><strong>Catatan:</strong> Anda harus menentukan <code>language_name</code> atau <code>language_code</code><br>Anda dapat memperoleh daftar lokasi yang tersedia beserta <code>language_code</code>-nya dengan membuat permintaan terpisah ke <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>contoh:<br><code class=\"long-string\">en</code>"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>tanggal mulai rentang waktu</em><br>field opsional<br>jika Anda tidak menentukan field ini, data akan disediakan untuk 6 bulan sebelumnya<br>nilai minimum yang mungkin: <code>2020-10-01</code><br>format tanggal: <code>\"yyyy-mm-dd\"</code>"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>tanggal akhir rentang waktu</em><br>field opsional<br>jika Anda tidak menentukan field ini, tanggal hari ini akan digunakan secara default<br>format tanggal: <code>\"yyyy-mm-dd\"</code><br>contoh:<br><code>\"2021-04-01\"</code>"
          },
          "correlate": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>mengorelasikan data dengan kumpulan data yang diperoleh sebelumnya</em><br>field opsional<br>nilai default: <code>true</code><br>jika Anda menggunakan parameter ini, sistem kami akan mengorelasikan data yang Anda peroleh sekarang dengan kumpulan data yang diperoleh sebelumnya<br>parameter ini dimaksudkan untuk mengurangi inkonsistensi yang mungkin timbul akibat perubahan pada basis data kami<br>kami menyarankan untuk selalu menyetel <code>correlate</code> ke <code>true</code>"
          },
          "ignore_synonyms": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>abaikan kata kunci yang sangat mirip</em><br>field opsional<br>jika disetel ke <code class=\"prettyprint\">true</code>, hanya data berdasarkan kata kunci inti yang akan dikembalikan, data untuk semua kata kunci yang sangat mirip akan dikecualikan;  <br>nilai default: <code>false</code>"
          },
          "include_clickstream_data": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>menyertakan atau mengecualikan data dari metrik berbasis clickstream dalam hasil</em><br>field opsional<br>jika parameter disetel ke <code>true</code>, Anda akan menerima field <code>clickstream_etv</code>, <code>clickstream_gender_distribution</code>, dan <code>clickstream_age_distribution</code> beserta data clickstream dalam respons;<br>nilai default: <code>false</code>;<p><strong>Catatan:</strong> data clickstream historis tersedia sejak 2024/05 (Mei 2024);<br><strong>dengan parameter ini diaktifkan, Anda akan dikenakan biaya dua kali lipat untuk permintaan tersebut;</strong><br>pelajari lebih lanjut tentang cara metrik berbasis clickstream dihitung di artikel pusat bantuan ini"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>pengenal tugas yang ditentukan pengguna</em><br>field opsional<br><em>batas karakter adalah 255</em><br>Anda dapat menggunakan parameter ini untuk mengidentifikasi tugas dan mencocokkannya dengan hasil<br>Anda akan menemukan nilai <code>tag</code> yang ditentukan di objek <code>data</code> pada respons"
          }
        },
        "example": [
          {
            "target": "dataforseo.com",
            "location_code": 2840,
            "language_code": "en",
            "date_from": "2021-01-01",
            "date_to": "2021-03-29"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "location_code": 2840,
      "language_code": "en",
      "date_from": "2021-01-01",
      "date_to": "2021-03-29"
    }
  ]
}
```

## Responses

### 200 — Operasi berhasil

Headers:
- `X-Request-Id` (string) — Pengenal permintaan yang harus disertakan saat menghubungi dukungan Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo"
    }
  ]
}
```

### 400 — Permintaan tidak dapat diproses. Periksa parameter permintaan.

### 401 — Kunci API Felo yang valid diperlukan.

### 402 — Permintaan tidak dapat dilanjutkan karena persyaratan penagihan belum terpenuhi.

### 403 — Akun tidak diizinkan melakukan operasi ini.

### 429 — Batas permintaan atau batas pengeluaran telah tercapai.

### 502 — Layanan tidak dapat menyelesaikan permintaan.

### 503 — API atau layanan penagihan untuk sementara tidak tersedia.

### 504 — Layanan kehabisan waktu saat memproses permintaan.

### default — Respons error; respons passthrough upstream dapat menggunakan format penyedia

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "versi API saat ini"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "kode status umum; Anda dapat menemukan daftar lengkap kode respons di sini"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "pesan informasi umum; Anda dapat menemukan daftar lengkap pesan informasi umum di sini"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "total waktu eksekusi, detik"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total biaya tugas, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "jumlah tugas dalam array tasks",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "jumlah tugas dalam array tasks yang dikembalikan dengan error",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "pengenal tugas; pengenal tugas unik di sistem kami dalam format UUID"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "kode status tugas yang dihasilkan oleh DataForSEO; dapat berada dalam rentang berikut: 10000-60000; Anda dapat menemukan daftar lengkap kode respons di sini"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "pesan informasi tugas; Anda dapat menemukan daftar lengkap pesan informasi umum di sini"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "waktu eksekusi, detik"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total biaya tugas, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "jumlah elemen dalam array hasil",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "Jalur URL"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "berisi parameter yang sama dengan yang Anda tentukan dalam permintaan POST"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>jenis mesin pencari</em>"
    },
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>tahun data disediakan</em>"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>bulan data disediakan</em>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo"
      },
      "description": "<em>data peringkat yang relevan dengan domain yang ditentukan</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo"
              }
            ]
          },
          "description": "<em>array tugas</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>jenis mesin pencari</em>"
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>domain target dalam array POST</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>kode lokasi dalam array POST</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>kode bahasa dalam array POST</em>"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah total hasil di basis data kami yang relevan dengan permintaan Anda</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah hasil yang dikembalikan dalam array <code>items</code></em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem"
          }
        ]
      },
      "description": "<em>berisi data peringkat dan trafik historis</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo"
              }
            ]
          },
          "description": "<em>array hasil</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsMetricsInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #1</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #2-3</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #4-10</em>"
    },
    "pos_11_20": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #11-20</em>"
    },
    "pos_21_30": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #21-30</em>"
    },
    "pos_31_40": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #31-40</em>"
    },
    "pos_41_50": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #41-50</em>"
    },
    "pos_51_60": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #51-60</em>"
    },
    "pos_61_70": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #61-70</em>"
    },
    "pos_71_80": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #71-80</em>"
    },
    "pos_81_90": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #81-90</em>"
    },
    "pos_91_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah SERP organik tempat domain atau subdomain berada di peringkat #91-100</em>"
    },
    "etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>volume trafik perkiraan</em><br>perkiraan trafik organik bulanan ke domain atau subdomain<br>dihitung sebagai produk dari CTR (click-through-rate) dan nilai volume pencarian semua kata kunci dalam kategori yang diperingkatkan domain atau subdomain<br>pelajari lebih lanjut cara metrik dihitung di artikel pusat bantuan ini"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah total SERP organik yang berisi domain atau subdomain</em>",
      "format": "int64"
    },
    "estimated_paid_traffic_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>perkiraan biaya mengubah trafik pencarian organik menjadi berbayar</em><br>mewakili perkiraan biaya bulanan (USD) untuk menjalankan iklan bagi semua kata kunci dalam kategori yang diperingkatkan domain atau subdomain<br>metrik dihitung sebagai produk dari nilai <code>etv</code> organik dan <code>cpc</code> berbayar dan menunjukkan biaya mendorong volume trafik organik bulanan perkiraan melalui iklan PPC di Google Search<br>pelajari lebih lanjut cara metrik dihitung di artikel pusat bantuan ini"
    },
    "is_new": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>jumlah elemen berperingkat baru</em><br>menunjukkan berapa banyak elemen berperingkat baru yang ditemukan untuk target yang ditentukan"
    },
    "is_up": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>peringkat naik</em><br>menunjukkan berapa banyak elemen berperingkat dari target yang ditentukan yang naik"
    },
    "is_down": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>peringkat turun</em><br>menunjukkan berapa banyak elemen berperingkat dari target yang ditentukan yang turun"
    },
    "is_lost": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>elemen berperingkat yang hilang</em><br>menunjukkan berapa banyak elemen berperingkat dari target yang ditentukan yang sebelumnya muncul di SERP, tetapi tidak ditemukan selama pemeriksaan terakhir"
    },
    "clickstream_etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>volume trafik perkiraan berdasarkan data clickstream</em><br>dihitung sebagai produk dari click-through-rate dan nilai volume pencarian clickstream dari semua kata kunci yang diperingkatkan domain<br>untuk mengambil hasil untuk field ini, parameter <code>include_clickstream_data</code> harus diatur ke <code>true</code><br>pelajari lebih lanjut cara metrik dihitung di artikel pusat bantuan ini",
      "format": "double"
    },
    "clickstream_gender_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>distribusi metrik berbasis clickstream perkiraan menurut gender</em><br>untuk mengambil hasil untuk field ini, parameter <code>include_clickstream_data</code> harus diatur ke <code>true</code><br>pelajari lebih lanjut cara metrik dihitung di artikel pusat bantuan ini"
    },
    "clickstream_age_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>distribusi metrik berbasis clickstream menurut usia</em><br>untuk mengambil hasil untuk field ini, parameter <code>include_clickstream_data</code> harus diatur ke <code>true</code><br>pelajari lebih lanjut cara metrik dihitung di artikel pusat bantuan ini"
    }
  }
}
```
