Skip to content

attribution reference

This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint. Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Send JSON with Content-Type: application/json. Where multiple shapes are shown, the handler selects the applicable operation or validates nested input.

{ asa_token: string;
customer_id?: string | undefined;
install_id?: string | undefined;
legacy_recheck?: boolean | undefined;
}

Validation schemas: appleSearchAdsAttributionSchema in the downloadable schema registry.

JSON response shape
AppleSearchAdsAttributionResponse
JSON response shape
{ status: "error";
reason: string;
terminal: false;
retryable: true;
retryAfterSeconds: number;
errorCode: "internal_error";
}

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: handleAppleAttribution.