Create Saas Object

curl --request POST \ --url https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "object_name": "<string>", "api_identifier": "<string>", "description": "<string>", "null_pct_overall": 123, "field_null_pct": {}, "field_distinct_pct": {}, "earliest_timestamp": "2023-11-07T05:31:56Z", "latest_timestamp": "2023-11-07T05:31:56Z", "date_grain": "<string>", "last_load_timestamp": "2023-11-07T05:31:56Z", "load_frequency": "<string>", "data_latency_minutes": 123, "is_staging_table": true, "is_active": true, "description_generated_at": "2023-11-07T05:31:56Z", "skip_embedding": false } '

{ "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "object_name": "<string>", "api_identifier": "<string>", "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "description": "<string>", "null_pct_overall": 123, "field_null_pct": {}, "field_distinct_pct": {}, "earliest_timestamp": "2023-11-07T05:31:56Z", "latest_timestamp": "2023-11-07T05:31:56Z", "date_grain": "<string>", "last_load_timestamp": "2023-11-07T05:31:56Z", "load_frequency": "<string>", "data_latency_minutes": 123, "is_staging_table": true, "is_active": true, "description_generated_at": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

source_id

string<uuid> | null

required

Query Parameters

organization_id

string<uuid> | null

resource_id

string<uuid> | null

integration_source_id

string<uuid> | null

data_source_id

string<uuid> | null

context_source_id

string<uuid> | null

job_id

string<uuid> | null

Body

application/json

Model for creating a new SaaS object.

integration_source_id

string<uuid>

required

The integration source this object belongs to

object_name

string

required

Display name for the SaaS object (e.g., 'Contact')

api_identifier

string

required

API identifier for the SaaS object (e.g., 'contacts')

description

string | null

Optional description of the object

null_pct_overall

number | null

Overall percentage of null values across all fields

field_null_pct

Field Null Pct · object

Mapping of field names to their null percentages

Show child attributes

field_distinct_pct

Field Distinct Pct · object

Mapping of field names to their distinct value percentages

Show child attributes

earliest_timestamp

string<date-time> | null

Earliest timestamp found in the object

latest_timestamp

string<date-time> | null

Latest timestamp found in the object

date_grain

string | null

Granularity of date data (daily, hourly, etc.)

last_load_timestamp

string<date-time> | null

When this object was last analyzed for metadata

load_frequency

string | null

How frequently this object is updated (e.g., 'DAILY', 'HOURLY')

data_latency_minutes

integer | null

Data latency in minutes

is_staging_table

boolean | null

Whether this is a staging/temporary object

is_active

boolean

default:true

Whether this object is enabled and visible to the analysis agent

description_source

enum<string> | null

How description was created: 'ai_generated' | 'manual_edit' | 'imported' | 'information_schema'

Available options:

ai_generated,

manual_edit,

imported,

information_schema

description_generated_at

string<date-time> | null

When description was last modified

skip_embedding

boolean

default:false

Skip automatic embedding trigger for bulk operations

Response

Successful Response

Response model for SaaS objects.

integration_source_id

string<uuid>

required

The integration source this object belongs to

object_name

string

required

Display name for the SaaS object (e.g., 'Contact')

api_identifier

string

required

API identifier for the SaaS object (e.g., 'contacts')

string<uuid>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

description

string | null

Optional description of the object

null_pct_overall

number | null

Overall percentage of null values across all fields

field_null_pct

Field Null Pct · object

Mapping of field names to their null percentages

Show child attributes

field_distinct_pct

Field Distinct Pct · object

Mapping of field names to their distinct value percentages

Show child attributes

earliest_timestamp

string<date-time> | null

Earliest timestamp found in the object

latest_timestamp

string<date-time> | null

Latest timestamp found in the object

date_grain

string | null

Granularity of date data (daily, hourly, etc.)

last_load_timestamp

string<date-time> | null

When this object was last analyzed for metadata

load_frequency

string | null

How frequently this object is updated (e.g., 'DAILY', 'HOURLY')

data_latency_minutes

integer | null

Data latency in minutes

is_staging_table

boolean | null

Whether this is a staging/temporary object

is_active

boolean

default:true

Whether this object is enabled and visible to the analysis agent

description_source

enum<string> | null

How description was created: 'ai_generated' | 'manual_edit' | 'imported' | 'information_schema'

Available options:

ai_generated,

manual_edit,

imported,

information_schema

description_generated_at

string<date-time> | null

When description was last modified