Audiences API

All URIs are relative to https://api.syntheticusers.com/api/v1

Method	HTTP request	Description
createAudience	POST /audiences	Create Audience
deleteAudience	DELETE /audiences/	Delete Audience
editAudience	PATCH /audiences/	Edit Audience
extendAudience	POST /audiences/{audience_id}/extend	Extend Audience
generateAudience	POST /audiences/{audience_id}/generate	Generate Audience
getAudience	GET /audiences/	Get Audience
listAudiences	GET /audiences	List Audiences

createAudience

Audience createAudience(audienceCreate)

Example

import { createConfiguration, AudiencesApi } from '';
import type { AudiencesApiCreateAudienceRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AudiencesApi(configuration);

const request: AudiencesApiCreateAudienceRequest = {
  
  audienceCreate: {
    title: "title_example",
    description: "description_example",
    projectId: "projectId_example",
  },
};

const data = await apiInstance.createAudience(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
audienceCreate	AudienceCreate

Return type

Audience

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

deleteAudience

any deleteAudience()

Example

import { createConfiguration, AudiencesApi } from '';
import type { AudiencesApiDeleteAudienceRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AudiencesApi(configuration);

const request: AudiencesApiDeleteAudienceRequest = {
  
  audienceId: "audience_id_example",
};

const data = await apiInstance.deleteAudience(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
audienceId	[string]		defaults to undefined

Return type

any

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

editAudience

Audience editAudience(audienceUpdate)

Example

import { createConfiguration, AudiencesApi } from '';
import type { AudiencesApiEditAudienceRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AudiencesApi(configuration);

const request: AudiencesApiEditAudienceRequest = {
  
  audienceId: "audience_id_example",
  
  audienceUpdate: {
    title: "title_example",
    description: "description_example",
  },
};

const data = await apiInstance.editAudience(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
audienceUpdate	AudienceUpdate
audienceId	[string]		defaults to undefined

Return type

Audience

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

extendAudience

any extendAudience(audienceExtend)

Example

import { createConfiguration, AudiencesApi } from '';
import type { AudiencesApiExtendAudienceRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AudiencesApi(configuration);

const request: AudiencesApiExtendAudienceRequest = {
  
  audienceId: "audience_id_example",
  
  audienceExtend: {
    quantity: 1,
  },
};

const data = await apiInstance.extendAudience(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
audienceExtend	AudienceExtend
audienceId	[string]		defaults to undefined

Return type

any

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

generateAudience

Array<string> generateAudience(audienceGenerate)

Example

import { createConfiguration, AudiencesApi } from '';
import type { AudiencesApiGenerateAudienceRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AudiencesApi(configuration);

const request: AudiencesApiGenerateAudienceRequest = {
  
  audienceId: "audience_id_example",
  
  audienceGenerate: {
    quantity: 1,
    problems: [
      "problems_example",
    ],
    researchGoalId: "researchGoalId_example",
    files: [
      "files_example",
    ],
  },
};

const data = await apiInstance.generateAudience(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
audienceGenerate	AudienceGenerate
audienceId	[string]		defaults to undefined

Return type

Array<string>

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

getAudience

Audience getAudience()

Example

import { createConfiguration, AudiencesApi } from '';
import type { AudiencesApiGetAudienceRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AudiencesApi(configuration);

const request: AudiencesApiGetAudienceRequest = {
  
  audienceId: "audience_id_example",
};

const data = await apiInstance.getAudience(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
audienceId	[string]		defaults to undefined

Return type

Audience

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]

listAudiences

PageAudience listAudiences()

Example

import { createConfiguration, AudiencesApi } from '';
import type { AudiencesApiListAudiencesRequest } from '';

const configuration = createConfiguration();
const apiInstance = new AudiencesApi(configuration);

const request: AudiencesApiListAudiencesRequest = {
    // Comma-separated list of audience IDs (optional)
  id: "id_example",
    // Comma-separated list of project IDs (optional)
  projectId: "projectId_example",
    // Page number (optional)
  page: 1,
    // Page size (optional)
  size: 50,
};

const data = await apiInstance.listAudiences(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
id	[string]	Comma-separated list of audience IDs	(optional) defaults to undefined
projectId	[string]	Comma-separated list of project IDs	(optional) defaults to undefined
page	[number]	Page number	(optional) defaults to 1
size	[number]	Page size	(optional) defaults to 50

Return type

PageAudience

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to SDK]