# API

{% hint style="warning" %}
This section is intended for developers utilizing our APIs to add channels.
{% endhint %}

Below you will find the keys to generate secret payloads for adding or updating a channel via the [Script API](https://docs.edgetag.io/api/api/script).

Refer to the [onboarding](/channels/claritas/onboarding.md) page for detailed information on the purpose and usage of each input.

### CLARITAS\_PIXEL\_ID <a href="#claritaspixelid" id="claritaspixelid"></a>

Use for storing the Pixel ID that identifies your specific tracking pixel within the Claritas platform. This ID determines where your event data should be sent for processing.

**Example value**

```
23765
```

**Type**\
TEXT

**Optional**\
false

### CLARITAS\_CONVERSIONS <a href="#claritasconversions" id="claritasconversions"></a>

Use for storing the event mapping configuration as a stringified JSON object. Each key represents an EdgeTag event name, and each value is an object containing the event name and gid (goal ID) for Claritas.

**Example value**

```
{"Purchase":{"event":"claritas_purchase","gid":1},"AddToCart":{"event":"claritas_add_to_cart","gid":2},"PageView":{"event":"claritas_page_view","gid":3}}
```

**Value Structure:**

* Array of arrays format: `[[edgeTagEvent, claritasEvent], [edgeTagEvent, claritasEvent]]`
* First element: EdgeTag event name (string)
* Second element: Claritas event name (string)
* Must be stringified when stored as a secret

**Type**\
TEXT

**Optional**\
false

<br>

<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.edgetag.io/channels/claritas/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.