Pre-release

This release is a pre-release and may not be stable for production use.

delivr-sdk

Unified Delivr.ai public API. Merged from the curated domain specs: account/credentials, audiences, campaigns, events/identity, exports/integrations, field-catalog, intent enrichment, lists, pixel-tracking, platform-management, taxonomy.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.24.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import delivr_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import delivr_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import delivr_sdk
from delivr_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.delivr.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = delivr_sdk.Configuration(
    host = "https://api.delivr.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerJWT
configuration = delivr_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Configure API key authorization: ApiSecret
configuration.api_key['ApiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiSecret'] = 'Bearer'


# Enter a context with an instance of the API client
with delivr_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = delivr_sdk.APIClientsApi(api_client)
    create_api_client_request = delivr_sdk.CreateApiClientRequest() # CreateApiClientRequest | 

    try:
        # Create an API client
        api_response = api_instance.create_api_client(create_api_client_request)
        print("The response of APIClientsApi->create_api_client:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIClientsApi->create_api_client: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.delivr.ai

Class Method HTTP request Description
APIClientsApi create_api_client POST /client/v1 Create an API client
APIClientsApi delete_api_client DELETE /client/v1/{client_id} Delete an API client
APIClientsApi get_api_client GET /client/v1/{client_id} Get an API client
APIClientsApi list_api_clients GET /client/v1 List API clients
AppsApi create_app POST /public/core/api/app/create Create application
AppsApi delete_app DELETE /public/core/api/app/delete Delete application
AppsApi get_app GET /public/core/api/app/retrieve/{app_id} Retrieve application details
AppsApi list_apps GET /public/core/api/app/get List applications
AppsApi update_app PUT /public/core/api/app/update Update application
AudiencesApi clone_audience POST /api/v1/audiences/{id}/clone Clone audience
AudiencesApi create_audience POST /api/v1/audiences Create audience
AudiencesApi delete_audience DELETE /api/v1/audiences/{id} Delete audience
AudiencesApi download_audience GET /api/v1/audiences/{id}/download Download audience files
AudiencesApi estimate_audience_size POST /api/v1/audiences/estimate Estimate audience size before saving
AudiencesApi get_audience GET /api/v1/audiences/{id} Get audience
AudiencesApi get_audience_availability GET /api/v1/audiences/availability Check intent data availability
AudiencesApi get_audience_sample GET /api/v1/audiences/{id}/sample Get audience sample
AudiencesApi get_audience_status GET /api/v1/audiences/{id}/status Get audience task status
AudiencesApi list_audiences GET /api/v1/audiences List audiences
AudiencesApi pause_audience POST /api/v1/audiences/{id}/pause Pause audience
AudiencesApi refresh_audience POST /api/v1/audiences/{id}/refresh Refresh audience
AudiencesApi resume_audience POST /api/v1/audiences/{id}/resume Resume audience
AudiencesApi trigger_audience_unload POST /api/v1/audiences/{id}/unload Trigger audience unload
AudiencesApi update_audience PUT /api/v1/audiences/{id} Update audience
AuthenticationApi issue_token POST /public/core/auth/issue Issue JWT token
AuthenticationApi login POST /auth/v1/login Sign in
AuthenticationApi register POST /auth/v1/register Register a user
CampaignBudgetApi get_campaign_budget_status GET /api/v1/campaigns/{id}/budget-status Get campaign budget status
CampaignBudgetApi get_project_budget_summary GET /api/v1/campaigns/budget-summary Project budget summary
CampaignListsApi list_campaign_lists GET /api/v1/campaigns/{id}/lists List attached lists
CampaignMatchRatesApi get_campaign_match_rates GET /api/v1/campaigns/{id}/match-rates Get campaign match rates
CampaignPerformanceApi get_campaign_performance GET /api/v1/campaigns/{id}/performance Get campaign performance
CampaignPerformanceApi get_project_performance_summary GET /api/v1/campaigns/performance-summary Project performance summary
CampaignsApi get_campaign GET /api/v1/campaigns/{id} Get campaign
CampaignsApi list_campaigns GET /api/v1/campaigns List campaigns
CategoriesApi count_categories GET /api/v1/taxonomy/categories/count Count categories
CategoriesApi get_category GET /api/v1/taxonomy/categories/{category_id} Get category
CategoriesApi list_categories GET /api/v1/taxonomy/categories List categories
CookieSyncApi cookie_sync GET /pixel/core/api/sync Cookie sync
EventsApi get_event_counts GET /api/v1/event_counts Count events
EventsApi get_event_counts_v2 GET /api/v2/event_counts Count events (v2)
EventsApi get_events GET /api/v1/events Query events
EventsApi get_events_resolution_full_profile GET /api/v3/events/resolution_full_profile Query events (full profile resolutions tier)
EventsApi get_events_resolution_hem GET /api/v3/events/resolution_hem Query events (hem resolutions tier)
EventsApi get_events_resolution_hem_pte GET /api/v3/events/resolution_hem_pte Query events (hem + pte resolutions tier)
EventsApi get_events_schema GET /api/v1/events_schema Get event schema
EventsApi get_events_schema_resolution_full_profile GET /api/v3/events/resolution_full_profile/schema Get schema (full profile resolutions tier)
EventsApi get_events_schema_resolution_hem GET /api/v3/events/resolution_hem/schema Get schema (hem resolutions tier)
EventsApi get_events_schema_resolution_hem_pte GET /api/v3/events/resolution_hem_pte/schema Get schema (hem + pte resolutions tier)
EventsApi get_events_schema_v2 GET /api/v2/events_schema Get event schema (v2)
EventsApi get_events_schema_v3 GET /api/v3/events_schema Get event schema (v3)
EventsApi get_events_schema_web_event GET /api/v3/events/web_event/schema Get schema (web events tier)
EventsApi get_events_v2 GET /api/v2/events Query events (v2)
EventsApi get_events_web_event GET /api/v3/events/web_event Query events (web events tier)
EventsApi send_event POST /pixel/core/api/send-event Send pixel event (POST)
EventsApi send_event_get GET /pixel/core/api/send-event/get Send pixel event (GET)
ExportsApi create_export POST /api/v1/exports Create an export
ExportsApi delete_export DELETE /api/v1/exports/{id} Delete an export
ExportsApi get_export GET /api/v1/exports/{id} Get an export
ExportsApi list_exports GET /api/v1/exports List exports
ExportsApi update_export PUT /api/v1/exports/{id} Update an export
FieldCatalogApi get_field_by_key GET /api/v1/field-catalog/{key} Get field by key
FieldCatalogApi list_field_categories GET /api/v1/field-catalog/categories List categories
FieldCatalogApi list_fields GET /api/v1/field-catalog List fields
FileImportApi get_list_import_status GET /api/v1/lists/imports/{jobId} Poll import status
FileImportApi presign_list_import POST /api/v1/lists/{id}/imports/presign Get presigned upload URL
FileImportApi trigger_list_import POST /api/v1/lists/{id}/imports Trigger import
IdentityApi convert_hems_to_uid2 POST /api/v1/uid2/convert Convert hashed emails to UID2
IdentityApi lookup_hem GET /api/v1/lookup Resolve identity
IdentityApi query_contacts POST /api/v1/contact/query Batch contact enrichment
IdentityApi whoami GET /api/v1/whoami Verify an API key
IntegrationsApi create_integration POST /api/v1/integrations Create an integration
IntegrationsApi delete_integration DELETE /api/v1/integrations/{id} Delete an integration
IntegrationsApi get_integration GET /api/v1/integrations/{id} Get an integration
IntegrationsApi get_integration_crm_config GET /api/v1/integrations/{id}/crm-config Get CRM field mapping
IntegrationsApi list_integrations GET /api/v1/integrations List integrations
IntegrationsApi update_integration PUT /api/v1/integrations/{id} Update an integration
IntegrationsApi update_integration_crm_config PUT /api/v1/integrations/{id}/crm-config Update CRM field mapping
IntentDiscoveryApi intent_companies_by_topic POST /api/v1/intent/companies Find companies researching a topic
IntentDiscoveryApi intent_companies_by_topic_multi POST /api/v1/intent/companies/multi Find companies across multiple topics
IntentDiscoveryApi intent_people_by_topic POST /api/v1/intent/people Find people researching a topic
IntentDiscoveryApi intent_people_by_topic_multi POST /api/v1/intent/people/multi Find people across multiple topics
IntentLookupApi intent_batch POST /api/v1/intent/batch Look up person intent in bulk
IntentLookupApi intent_company POST /api/v1/intent/company Look up company intent
IntentLookupApi intent_company_batch POST /api/v1/intent/company/batch Look up company intent in bulk
IntentLookupApi intent_lookup POST /api/v1/intent/lookup Look up person intent
IntentPreviewApi intent_companies_by_topic_multi_preview POST /api/v1/intent/companies/multi/preview Preview companies across multiple topics
IntentPreviewApi intent_companies_by_topic_preview POST /api/v1/intent/companies/preview Preview companies researching a topic
IntentPreviewApi intent_people_by_topic_multi_preview POST /api/v1/intent/people/multi/preview Preview people across multiple topics
IntentPreviewApi intent_people_by_topic_preview POST /api/v1/intent/people/preview Preview people researching a topic
ListValuesApi bulk_add_list_values POST /api/v1/lists/{id}/values/batch Bulk add values
ListValuesApi bulk_delete_list_values DELETE /api/v1/lists/{id}/values/batch Bulk remove values
ListsApi bulk_delete_lists DELETE /api/v1/lists/batch Bulk delete lists
ListsApi create_list POST /api/v1/lists Create list
ListsApi delete_list DELETE /api/v1/lists/{id} Delete list
ListsApi get_list GET /api/v1/lists/{id} Get list
ListsApi list_lists GET /api/v1/lists List lists
ListsApi update_list PUT /api/v1/lists/{id} Update list
OrganizationApi delete_organization DELETE /api/v1/organization Delete the API key's organization
OrganizationApi get_organization GET /api/v1/organization Retrieve the API key's organization
OrganizationApi get_organization_by_id GET /public/core/api/organization/retrieve/{organization_id} Retrieve organization
OrganizationApi partner_update_organization PUT /public/core/api/organization/update Update organization
OrganizationApi update_organization PUT /api/v1/organization Update the API key's organization
OrganizationUserApi create_organization_user POST /api/v1/organization/user/create Add a member to the API key's organization
OrganizationUserApi delete_organization_user DELETE /api/v1/organization/user/delete Remove a member from the API key's organization
OrganizationUserApi get_organization_user GET /api/v1/organization/user/retrieve/{organization_user_id} Retrieve a member of the API key's organization
OrganizationUserApi list_organization_users GET /api/v1/organization/user/get List members of the API key's organization
OrganizationUserApi partner_create_organization_user POST /public/core/api/organization/user/create Create organization user
OrganizationUserApi partner_delete_organization_user DELETE /public/core/api/organization/user/delete Deactivate organization user
OrganizationUserApi partner_get_organization_user GET /public/core/api/organization/user/retrieve/{organization_user_id} Retrieve organization user
OrganizationUserApi partner_list_organization_users GET /public/core/api/organization/user/get List organization users
OrganizationUserApi partner_update_organization_user PUT /public/core/api/organization/user/update Update organization user
OrganizationUserApi update_organization_user PUT /api/v1/organization/user/update Update a member of the API key's organization
PixelApi create_pixel POST /api/v1/pixel/create Create a pixel in a project
PixelApi delete_pixel DELETE /api/v1/pixel/delete Delete a pixel
PixelApi get_pixel GET /api/v1/pixel/retrieve/{pixel_id} Retrieve a pixel
PixelApi list_pixels GET /api/v1/pixel/get List pixels in a project
PixelApi partner_create_pixel POST /public/core/api/pixel/create Create pixel
PixelApi partner_delete_pixel DELETE /public/core/api/pixel/delete Delete pixel
PixelApi partner_get_pixel GET /public/core/api/pixel/retrieve/{pixel_id} Retrieve pixel
PixelApi partner_list_pixels GET /public/core/api/pixel/get List pixels
PixelApi partner_update_pixel PUT /public/core/api/pixel/update Update pixel
PixelApi update_pixel PUT /api/v1/pixel/update Update a pixel
PixelScriptApi get_pixel_script GET /pixel/core/api/pixel.js Get pixel JavaScript
ProjectApi create_project POST /api/v1/project/create Create a project in the API key's organization
ProjectApi delete_project DELETE /api/v1/project/delete Delete a project in the API key's organization
ProjectApi get_project GET /api/v1/project/retrieve/{project_id} Retrieve a project in the API key's organization
ProjectApi list_projects GET /api/v1/project/get List projects in the API key's organization
ProjectApi partner_create_project POST /public/core/api/project/create Create project
ProjectApi partner_delete_project DELETE /public/core/api/project/delete Deactivate project
ProjectApi partner_get_project GET /public/core/api/project/retrieve/{project_id} Retrieve project
ProjectApi partner_list_projects GET /public/core/api/project/get List projects
ProjectApi partner_update_project PUT /public/core/api/project/update Update project
ProjectApi update_project PUT /api/v1/project/update Update a project in the API key's organization
ProjectUserApi create_project_user POST /api/v1/project/user/create Add a member to a project
ProjectUserApi delete_project_user DELETE /api/v1/project/user/delete Remove a member from a project
ProjectUserApi get_project_user GET /api/v1/project/user/retrieve/{project_user_id} Retrieve a project member
ProjectUserApi list_project_users GET /api/v1/project/user/get List members of a project
ProjectUserApi partner_create_project_user POST /public/core/api/project/user/create Create project user
ProjectUserApi partner_delete_project_user DELETE /public/core/api/project/user/delete Deactivate project user
ProjectUserApi partner_get_project_user GET /public/core/api/project/user/retrieve/{project_user_id} Retrieve project user
ProjectUserApi partner_list_project_users GET /public/core/api/project/user/get List project users
ProjectUserApi partner_update_project_user PUT /public/core/api/project/user/update Update project user
ProjectUserApi update_project_user PUT /api/v1/project/user/update Update a project member
SchemaApi get_audience_schema GET /api/v1/audiences/schema Get audience schema
SubcategoriesApi count_subcategories GET /api/v1/taxonomy/subcategories/count Count subcategories
SubcategoriesApi get_subcategory GET /api/v1/taxonomy/subcategories/{subcategory_id} Get subcategory
SubcategoriesApi list_subcategories GET /api/v1/taxonomy/subcategories List subcategories
TopicRequestsApi create_topic_request POST /api/v1/taxonomy/topic-requests Create topic request
TopicRequestsApi get_topic_request GET /api/v1/taxonomy/topic-requests/{topic_request_id} Get topic request
TopicRequestsApi list_topic_requests GET /api/v1/taxonomy/topic-requests List topic requests
TopicRequestsApi update_topic_request PUT /api/v1/taxonomy/topic-requests/{topic_request_id} Resubmit topic request
TopicsApi count_topics GET /api/v1/taxonomy/topics/count Count topics
TopicsApi get_topic GET /api/v1/taxonomy/topics/{topic_id} Get topic
TopicsApi list_topics GET /api/v1/taxonomy/topics List topics
UserApi get_user_overview GET /public/core/api/user/overview List organizations and projects for the authenticated user

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header

ApiSecret

  • Type: API key
  • API key parameter name: X-Api-Secret
  • Location: HTTP header

BearerJWT

  • Type: Bearer authentication (JWT)

ClientId

  • Type: API key
  • API key parameter name: X-Delivr-Client-ID
  • Location: HTTP header

ClientSecret

  • Type: API key
  • API key parameter name: X-Delivr-Client-Secret
  • Location: HTTP header

Author

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.1.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ryanspoone from gravatar.com ryanspoone

Credits

Author: OpenAPI Generator community

License

Proprietary

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Delivr API

Report project as malware

Metadata

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.1.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ryanspoone from gravatar.com ryanspoone

Credits

Author: OpenAPI Generator community

License

Proprietary

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Delivr API

Report project as malware

Release files for delivr-sdk 1.0.0rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for delivr-sdk 1.0.0rc1
File Size Uploaded
delivr_sdk-1.0.0rc1.tar.gz 259.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for delivr-sdk 1.0.0rc1
File Interpreter ABI Platform
delivr_sdk-1.0.0rc1-py3-none-any.whl 629.9 kB Python 3 none any Details

Total release size: 889.4 kB

Release files / delivr_sdk-1.0.0rc1.tar.gz

Download URL delivr_sdk-1.0.0rc1.tar.gz
Size 259.5 kB
Tags Source
SHA-256 checksum
How to use checksums 		95e7b7a405bcbe21f4091cd0635a42eaefd28a3256e54eaff76b1d5fd9f55477
BLAKE2b-256 checksum
How to use checksums 		7ecebdfac023475d5817e2f8822dc2b453ebec524cfcec8ae2edd6876a31b890
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/7.0.0 CPython/3.14.6

Release files / delivr_sdk-1.0.0rc1-py3-none-any.whl

Download URL delivr_sdk-1.0.0rc1-py3-none-any.whl
Size 629.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		21abe3bad9ddb162dbbca1b785c29ab471125d8d3721e428c937da406d868a94
BLAKE2b-256 checksum
How to use checksums 		60e66f0377dc6d2c826484fce984338ead92a45d6235ddef40f7083e68ce4e49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/7.0.0 CPython/3.14.6
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page