API clients / Swift

Insights API client

The Insights API client is part of the Algolia.Search package. You can add this package to your Package.swift file:

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// swift-tools-version: 5.10
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
  name: "Algolia API clients",
  platforms: [
    .macOS(.v11)
  ],
  dependencies: [
    .package(
      url: "https://github.com/algolia/algoliasearch-client-swift.git", from: "9.17.0")
  ],
  targets: [
    .executableTarget(
      name: "Algolia API clients",
      dependencies: [
        .product(name: "Insights", package: "algoliasearch-client-swift")
      ]
    )
  ]
)

To use the Insights client, add this import to your files:

Copy 
1

import Insights

To create an instance of the client:

Copy 
1

let client = try InsightsClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)

Make sure to use the region that matches your Algolia application’s analytics region: region.us for the United States and region.de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

List of methods

Each method makes one request to the Insights API.

Events

client.pushEvents Send events

User tokens

client.deleteUserToken Delete user token
Did you find this page helpful?
Swift API clients v9