Delete user token events

Deletes all events related to the specified user token from events metrics and analytics.

Required ACL: deleteObject

The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see Delete a user profile in the Personalization API.

Usage

C#

// Initialize the client
var client = new InsightsClient(
  new InsightsConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);

// Call the API
await client.DeleteUserTokenAsync("test-user-1");

// Initialize the client
final client = InsightsClient(
    appId: 'ALGOLIA_APPLICATION_ID',
    apiKey: 'ALGOLIA_API_KEY',
    region: 'ALGOLIA_APPLICATION_REGION');

// Call the API
await client.deleteUserToken(
  userToken: "test-user-1",
);

// Initialize the client with your application region, eg. insights.ALGOLIA_APPLICATION_REGION
client, err := insights.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", insights.US)
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

// Call the API
err = client.DeleteUserToken(client.NewApiDeleteUserTokenRequest(
  "test-user-1"))
if err != nil {
  // handle the eventual error
  panic(err)
}

// Initialize the client
InsightsClient client = new InsightsClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");

// Call the API
client.deleteUserToken("test-user-1");

// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initInsights({ region: 'us' });

// Call the API
await client.deleteUserToken({ userToken: 'test-user-1' });

// Initialize the client
val client =
  InsightsClient(
    appId = "ALGOLIA_APPLICATION_ID",
    apiKey = "ALGOLIA_API_KEY",
    region = "ALGOLIA_APPLICATION_REGION",
  )

// Call the API
client.deleteUserToken(userToken = "test-user-1")

// Initialize the client
$client = InsightsClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');

// Call the API
$client->deleteUserToken(
    'test-user-1',
);

# Initialize the client
# In an asynchronous context, you can use InsightsClient instead, which exposes the exact same methods.
client = InsightsClientSync(
    "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)

# Call the API
client.delete_user_token(
    user_token="test-user-1",
)

# Initialize the client
client = Algolia::InsightsClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")

# Call the API
client.delete_user_token("test-user-1")

// Initialize the client
val client = InsightsClient(
  appId = "ALGOLIA_APPLICATION_ID",
  apiKey = "ALGOLIA_API_KEY",
  region = Option("ALGOLIA_APPLICATION_REGION")
)

// Call the API
Await.result(
  client.deleteUserToken(
    userToken = "test-user-1"
  ),
  Duration(100, "sec")
)

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

// Call the API
try await client.deleteUserToken(userToken: "test-user-1")

See the full API reference

For more details about input parameters and response fields.