Audiences API

Auto-generated from codebase analysis

This section documents the Audiences API endpoints.

GET Endpoints

GET /api/audiences

List audiences filtered by current target database/schema.

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/audiences/dashboard

Get all audiences with metrics in a single query for dashboard.

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences/dashboard" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/audiences/performance-metrics

Get performance metrics for audiences

Parameters

Name	Type	Required	Description
audience_segment_id	Optional[str]	No
ad_platform	Optional[str]	No
campaign_id	Optional[str]	No
start_date	Optional[str]	No
end_date	Optional[str]	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences/performance-metrics" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/audiences/{audience_id}

Parameters

Name	Type	Required	Description
audience_id	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/audiences/{audience_id}/exports

Get exports for a specific audience

Parameters

Name	Type	Required	Description
audience_id	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}/exports" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/audiences/{audience_id}/exports/{export_id}/preview

Get a preview of the data in an audience export

Parameters

Name	Type	Required	Description
audience_id	str	Yes
export_id	str	Yes
limit	int	No

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}/exports/{export_id}/preview" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/audiences/{audience_id}/performance-summary

Get audience performance summary for a specific audience

Parameters

Name	Type	Required	Description
audience_id	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}/performance-summary" \
  -H "Authorization: Bearer YOUR_TOKEN"

GET /api/audiences/{audience_id}/size

Get the number of materialized rows for an audience

Parameters

Name	Type	Required	Description
audience_id	str	Yes

Example Request

curl -X GET "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}/size" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST Endpoints

POST /api/audiences

Create a new audience.

Parameters

Name	Type	Required	Description
audience	Audience	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/api/audiences" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /api/audiences/{audience_id}/materialize

Parameters

Name	Type	Required	Description
audience_id	str	Yes

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}/materialize" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /api/audiences/exports

Create a new audience export

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/api/audiences/exports" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /api/audiences/performance-metrics

Create performance metrics record

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/api/audiences/performance-metrics" \
  -H "Authorization: Bearer YOUR_TOKEN"

POST /api/audiences/conversions

Create a conversion record

Example Request

curl -X POST "https://your-instance.datalinx.ai/api/api/audiences/conversions" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT Endpoints

PUT /api/audiences/{audience_id}

Parameters

Name	Type	Required	Description
audience_id	str	Yes
audience	AudienceInput	Yes

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT /api/audiences/exports/{export_id}

Update an existing audience export

Parameters

Name	Type	Required	Description
export_id	str	Yes

Example Request

curl -X PUT "https://your-instance.datalinx.ai/api/api/audiences/exports/{export_id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE Endpoints

DELETE /api/audiences/{audience_id}

Parameters

Name	Type	Required	Description
audience_id	str	Yes

Example Request

curl -X DELETE "https://your-instance.datalinx.ai/api/api/audiences/{audience_id}" \
  -H "Authorization: Bearer YOUR_TOKEN"