[**@s4ai/core Documentation v0.3.23**](../../../README.md)

***

[@s4ai/core Documentation](../../../modules.md) / [autonomous/s4-user-acquisition](../README.md) / getS4UserAcquisitionModule

# Function: getS4UserAcquisitionModule()

> **getS4UserAcquisitionModule**(`options?`): `object`

Defined in: autonomous/s4-user-acquisition.js:106

## Parameters

### options?

## Returns

`object`

### captureLead()

> **captureLead**(`payload?`): `Promise`\<\{ `campaign`: `string`; `content`: `string`; `createdAt`: `any`; `email`: `string` \| `null`; `id`: `any`; `ip`: `string`; `landingPage`: `string`; `medium`: `string`; `metadata`: `any`; `referrer`: `string`; `source`: `string`; `tags`: `any`; `term`: `string`; `type`: `string`; `userAgent`: `string`; \}\>

#### Parameters

##### payload?

#### Returns

`Promise`\<\{ `campaign`: `string`; `content`: `string`; `createdAt`: `any`; `email`: `string` \| `null`; `id`: `any`; `ip`: `string`; `landingPage`: `string`; `medium`: `string`; `metadata`: `any`; `referrer`: `string`; `source`: `string`; `tags`: `any`; `term`: `string`; `type`: `string`; `userAgent`: `string`; \}\>

### getHealth()

> **getHealth**(): `Promise`\<\{ `status`: `string`; `timestamp`: `string`; `totals`: \{ `conversionRate`: `number`; `conversions`: `number`; `leads`: `number`; \}; \}\>

#### Returns

`Promise`\<\{ `status`: `string`; `timestamp`: `string`; `totals`: \{ `conversionRate`: `number`; `conversions`: `number`; `leads`: `number`; \}; \}\>

### getRecent()

> **getRecent**(`limit?`): `Promise`\<`any`\>

#### Parameters

##### limit?

`number` = `50`

#### Returns

`Promise`\<`any`\>

### getSummary()

> **getSummary**(): `Promise`\<\{ `campaigns`: `object`[]; `mediums`: `object`[]; `sources`: `object`[]; `totals`: \{ `conversionRate`: `number`; `conversions`: `number`; `leads`: `number`; \}; \}\>

#### Returns

`Promise`\<\{ `campaigns`: `object`[]; `mediums`: `object`[]; `sources`: `object`[]; `totals`: \{ `conversionRate`: `number`; `conversions`: `number`; `leads`: `number`; \}; \}\>

### recordConversion()

> **recordConversion**(`payload?`): `Promise`\<\{ `amount`: `number` \| `null`; `createdAt`: `any`; `currency`: `string`; `event`: `string`; `id`: `any`; `leadId`: `string`; `metadata`: `any`; `plan`: `string`; `stripeCustomerId`: `string`; `stripeSubscriptionId`: `string`; `type`: `string`; \}\>

#### Parameters

##### payload?

#### Returns

`Promise`\<\{ `amount`: `number` \| `null`; `createdAt`: `any`; `currency`: `string`; `event`: `string`; `id`: `any`; `leadId`: `string`; `metadata`: `any`; `plan`: `string`; `stripeCustomerId`: `string`; `stripeSubscriptionId`: `string`; `type`: `string`; \}\>