# Adlyft ## API Docs - Authentcation [Get User Token](https://docs.adlyfy.dev/get-user-token-29354603e0.md): Use this endpoint to create or trigger auth token in gateway. Authentication: x-api-key. - Authentcation [Refresh access token](https://docs.adlyfy.dev/refresh-access-token-29354598e0.md): Use this endpoint to retrieve auth refresh in gateway. Authentication: cookie. - Authentcation [Get User Token](https://docs.adlyfy.dev/get-user-token-33298348e0.md): Use this endpoint to create or trigger auth token in gateway. Authentication: x-api-key. - Connections [Create Connections](https://docs.adlyfy.dev/create-connections-29354632e0.md): Generates an authorization URL for connecting an external platform (e.g., Meta, Google Ads, etc.). Automatically assigns a team if not provided. Authentication: JWT-auth, x-api-key. - Connections [List Connections](https://docs.adlyfy.dev/list-connections-29354633e0.md): Use this endpoint to retrieve connections in gateway. Authentication: JWT-auth + x-api-key. - Connections [Get Connections Status](https://docs.adlyfy.dev/get-connections-status-29354635e0.md): Returns a list of all ad accounts and their current connection status with external platforms. Authentication: JWT-auth, x-api-key. - Connections [Delete Connections By Adsaccountid Remove Connection](https://docs.adlyfy.dev/delete-connections-by-adsaccountid-remove-connection-29354636e0.md): Removes the connection associated with the specified ad account from the tenant. Authentication: JWT-auth, x-api-key. - Connections [Get Connections By Id Insights](https://docs.adlyfy.dev/get-connections-by-id-insights-29354638e0.md): Use this endpoint to retrieve connections By id insights in gateway. Authentication: JWT-auth + x-api-key. - Connections [Get all external-user connections](https://docs.adlyfy.dev/get-all-external-user-connections-31993813e0.md): - Connections [Check connection status](https://docs.adlyfy.dev/check-connection-status-31993814e0.md): Returns whether the authenticated external user currently has a usable provider connection for each linked ad account. - Connections [Remove a connection by ads account ID](https://docs.adlyfy.dev/remove-a-connection-by-ads-account-id-31993815e0.md): Disconnects the provider connection associated with the specified ad account for the authenticated external user. - Connections [Revoke a connection by connection ID](https://docs.adlyfy.dev/revoke-a-connection-by-connection-id-31993816e0.md): Revokes the specified connection record directly by its connection identifier. - Connections [Read Meta ad account insights through the connection surface](https://docs.adlyfy.dev/read-meta-ad-account-insights-through-the-connection-surface-31993817e0.md): Fetches Meta insights for a linked ad account by using the connection resolved for the authenticated external user. - Connections [Create Connections](https://docs.adlyfy.dev/create-connections-33298349e0.md): Generates an authorization URL for connecting an external platform (e.g., Meta, Google Ads, etc.). Automatically assigns a team if not provided. Authentication: JWT-auth, x-api-key. - Connections [List Connections](https://docs.adlyfy.dev/list-connections-33298350e0.md): Use this endpoint to retrieve connections in gateway. Authentication: JWT-auth + x-api-key. - Connections [Generate OAuth authorization URL](https://docs.adlyfy.dev/generate-oauth-authorization-url-33298351e0.md): Creates the provider-specific authorization URL for a new connection owned by the authenticated external user. - Meta > Assets & Entities [List Meta Pages](https://docs.adlyfy.dev/list-meta-pages-29354645e0.md): Use this endpoint to retrieve By teamId meta pages in gateway. Authentication: JWT-auth + x-api-key. - Meta > Assets & Entities [List Meta Businesses](https://docs.adlyfy.dev/list-meta-businesses-29354648e0.md): Use this endpoint to retrieve By teamId meta businesses in gateway. Authentication: JWT-auth + x-api-key. - Meta > Assets & Entities [Get Meta Businesses By BusinessId](https://docs.adlyfy.dev/get-meta-businesses-by-businessid-29354649e0.md): Use this endpoint to retrieve By teamId meta businesses By businessId in gateway. Authentication: JWT-auth + x-api-key. - Meta > Assets & Entities [List Meta Businesses By BusinessId Ad Accounts](https://docs.adlyfy.dev/list-meta-businesses-by-businessid-ad-accounts-29354650e0.md): Use this endpoint to retrieve By teamId meta businesses By businessId ad accounts in gateway. Authentication: JWT-auth + x-api-key. - Meta > Assets & Entities [List Meta Businesses](https://docs.adlyfy.dev/list-meta-businesses-33298353e0.md): Use this endpoint to retrieve By teamId meta businesses in gateway. Authentication: JWT-auth + x-api-key. - Meta > Assets & Entities [Get Meta Businesses By BusinessId](https://docs.adlyfy.dev/get-meta-businesses-by-businessid-33298354e0.md): Use this endpoint to retrieve By teamId meta businesses By businessId in gateway. Authentication: JWT-auth + x-api-key. - Meta > Assets & Entities [List Meta Businesses By BusinessId Ad Accounts](https://docs.adlyfy.dev/list-meta-businesses-by-businessid-ad-accounts-33298355e0.md): Use this endpoint to retrieve By teamId meta businesses By businessId ad accounts in gateway. Authentication: JWT-auth + x-api-key. - Meta > Assets & Entities [List business product catalogs](https://docs.adlyfy.dev/list-business-product-catalogs-31993829e0.md): Returns product catalogs owned by the requested Meta business. - Meta > Audiences [List saved audiences](https://docs.adlyfy.dev/list-saved-audiences-31993821e0.md): Returns saved Meta audiences for the requested ad account. - Meta > Audiences [List custom audiences](https://docs.adlyfy.dev/list-custom-audiences-31993822e0.md): Returns custom Meta audiences for the requested ad account. - Meta > Audiences [Create a lookalike audience](https://docs.adlyfy.dev/create-a-lookalike-audience-31993823e0.md): Creates a Meta lookalike audience from the requested source audience or page fans. - Meta > Audiences [Estimate audience size](https://docs.adlyfy.dev/estimate-audience-size-31993830e0.md): Executes the current audience size estimation flow using the supplied targeting payload. This route currently accepts a body on a GET request because that is how the runtime is implemented. - Meta > Pixels [Create a Meta pixel](https://docs.adlyfy.dev/create-a-meta-pixel-31993831e0.md): Creates a Meta pixel for the requested ad account. - Meta > Pixels [List Meta pixels](https://docs.adlyfy.dev/list-meta-pixels-31993832e0.md): Returns pixels linked to the requested Meta ad account. - Meta > Pixels [Get Meta pixel details](https://docs.adlyfy.dev/get-meta-pixel-details-31993833e0.md): Returns metadata for the requested Meta pixel. - Meta > Pixels [Get Meta pixel stats](https://docs.adlyfy.dev/get-meta-pixel-stats-31993834e0.md): Returns event and aggregation statistics for the requested Meta pixel. - Meta > Pixels [Get Meta dataset quality](https://docs.adlyfy.dev/get-meta-dataset-quality-31993835e0.md): Returns dataset quality information for the requested Meta pixel. - Meta > Lead Forms [Create a Meta lead form](https://docs.adlyfy.dev/create-a-meta-lead-form-31993836e0.md): Creates a lead form for the requested Meta ad account. - Meta > Lead Forms [List Meta lead forms](https://docs.adlyfy.dev/list-meta-lead-forms-31993837e0.md): Returns lead forms for the requested Meta page. - Meta > Campaigns [Create a lead campaign](https://docs.adlyfy.dev/create-a-lead-campaign-31993838e0.md): Creates a Meta lead generation campaign. - Meta > Campaigns [Create an awareness campaign](https://docs.adlyfy.dev/create-an-awareness-campaign-31993839e0.md): Creates a Meta awareness campaign. - Meta > Campaigns [Create a traffic campaign](https://docs.adlyfy.dev/create-a-traffic-campaign-31993840e0.md): Creates a Meta traffic campaign. - Meta > Campaigns [Create an engagement campaign](https://docs.adlyfy.dev/create-an-engagement-campaign-31993841e0.md): Creates a Meta engagement campaign. - Meta > Campaigns [Create a sales campaign](https://docs.adlyfy.dev/create-a-sales-campaign-31993842e0.md): Creates a Meta sales campaign. - Meta > Campaigns [List Meta campaigns](https://docs.adlyfy.dev/list-meta-campaigns-31993844e0.md): Returns campaigns visible to the requested ad account and external-user context. - Meta > Campaigns [Get Meta campaign details](https://docs.adlyfy.dev/get-meta-campaign-details-31993845e0.md): Returns details for the requested Meta campaign. - Meta > Campaigns [Update Meta campaign status](https://docs.adlyfy.dev/update-meta-campaign-status-31993855e0.md): Updates the delivery status of the requested Meta campaign. - Meta > Insights [Read Meta insights](https://docs.adlyfy.dev/read-meta-insights-31993863e0.md): Runs the Meta insights query for the requested ad account and external-user context. - Meta > Ads [List ads for a Meta ad set](https://docs.adlyfy.dev/list-ads-for-a-meta-ad-set-31993849e0.md): Returns ads that belong to the requested Meta ad set. - Meta > Ads [List Meta ads](https://docs.adlyfy.dev/list-meta-ads-31993850e0.md): Returns ads visible to the requested ad account and external-user context. - Meta > Ads [Update Meta ad status](https://docs.adlyfy.dev/update-meta-ad-status-31993857e0.md): Updates the delivery status of the requested Meta ad. - Meta > Ads [List ads for a Meta campaign](https://docs.adlyfy.dev/list-ads-for-a-meta-campaign-31993846e0.md): Returns ads that belong to the requested Meta campaign. - Meta > Ads [Get Meta ad details](https://docs.adlyfy.dev/get-meta-ad-details-31993851e0.md): Returns details for the requested Meta ad. - Meta > Ads [Update Meta ad set status](https://docs.adlyfy.dev/update-meta-ad-set-status-31993856e0.md): Updates the delivery status of the requested Meta ad set. - Meta > Ads [List Meta ads](https://docs.adlyfy.dev/list-meta-ads-33298356e0.md): Returns ads visible to the requested ad account and external-user context. - Meta > Adset [List Meta ad sets](https://docs.adlyfy.dev/list-meta-ad-sets-31993847e0.md): Returns ad sets visible to the requested ad account and external-user context. - Meta > Adset [Get Meta ad set details](https://docs.adlyfy.dev/get-meta-ad-set-details-31993848e0.md): Returns details for the requested Meta ad set. - Meta > Ad Creatives [List Meta ad creatives](https://docs.adlyfy.dev/list-meta-ad-creatives-31993852e0.md): Returns ad creatives visible to the requested ad account and external-user context. - Meta > Ad Creatives [Preview a Meta ad creative](https://docs.adlyfy.dev/preview-a-meta-ad-creative-31993853e0.md): Generates a preview for the requested Meta ad creative. This route currently accepts a body on a GET request because that is how the runtime is implemented. - Meta > Ad Creatives [Get Meta ad creative details](https://docs.adlyfy.dev/get-meta-ad-creative-details-31993854e0.md): Returns details for the requested Meta ad creative. - Meta > Account details [List Meta ad accounts](https://docs.adlyfy.dev/list-meta-ad-accounts-31993824e0.md): Returns the Meta ad accounts available to the current connection context. - Meta > Account details [Get Meta ad account details](https://docs.adlyfy.dev/get-meta-ad-account-details-31993825e0.md): Returns detailed metadata for the requested Meta ad account. - Meta [Import Meta ad account data](https://docs.adlyfy.dev/import-meta-ad-account-data-31993819e0.md): Triggers the Meta import flow for the requested ad account after validating external-user ownership. - Meta [Search Meta targeting options](https://docs.adlyfy.dev/search-meta-targeting-options-31993843e0.md): Searches targeting entities supported by the Meta Marketing API. - Google Integration [List Google List Accessible Accounts](https://docs.adlyfy.dev/list-google-list-accessible-accounts-29354684e0.md): Use this endpoint to retrieve By teamId google list accessible accounts in gateway. Authentication: x-api-key. - Google Integration [List Google Import](https://docs.adlyfy.dev/list-google-import-29354685e0.md): Use this endpoint to retrieve By teamId google import in gateway. Authentication: x-api-key. - Google Integration [Get Google Insights](https://docs.adlyfy.dev/get-google-insights-29354686e0.md): Use this endpoint to retrieve By teamId google insights in gateway. Authentication: x-api-key. - Google Integration [List Google Assets](https://docs.adlyfy.dev/list-google-assets-29354687e0.md): Use this endpoint to retrieve By teamId google assets in gateway. Authentication: x-api-key. - Google Integration [List accessible Google ad accounts](https://docs.adlyfy.dev/list-accessible-google-ad-accounts-31993864e0.md): Returns the Google ad accounts accessible through the authenticated external user connection. - Google Integration [Import a Google ad account](https://docs.adlyfy.dev/import-a-google-ad-account-31993865e0.md): Validates ownership of the Google ad account and triggers the import flow for the authenticated external user. - Google Integration [Read Google insights](https://docs.adlyfy.dev/read-google-insights-31993866e0.md): Runs the Google insights query for a validated ad account owned by the authenticated external user. - Google Integration [Read Google assets](https://docs.adlyfy.dev/read-google-assets-31993867e0.md): Reads Google entities and reporting assets for a validated ad account owned by the authenticated external user. - Google Integration [Execute a Google GAQL query](https://docs.adlyfy.dev/execute-a-google-gaql-query-31993868e0.md): Executes a raw or structured Google Ads Query Language request for a validated ad account owned by the authenticated external user. - TikTok Integration [Create TikTok Import](https://docs.adlyfy.dev/create-tiktok-import-29354688e0.md): Use this endpoint to create or trigger By teamId tiktok import in gateway. Authentication: x-api-key. - TikTok Integration [List TikTok Assets](https://docs.adlyfy.dev/list-tiktok-assets-29354689e0.md): Use this endpoint to retrieve By teamId tiktok assets in gateway. Authentication: x-api-key. - TikTok Integration [Get TikTok Insights](https://docs.adlyfy.dev/get-tiktok-insights-29354690e0.md): Use this endpoint to retrieve By teamId tiktok insights in gateway. Authentication: x-api-key. - TikTok Integration [Create TikTok Assets Status Update](https://docs.adlyfy.dev/create-tiktok-assets-status-update-29354691e0.md): Use this endpoint to create or trigger By teamId tiktok assets status update in gateway. Authentication: x-api-key. - TikTok Integration [Create TikTok Assets Ads](https://docs.adlyfy.dev/create-tiktok-assets-ads-29354692e0.md): Use this endpoint to create or trigger By teamId tiktok assets ads in gateway. Authentication: x-api-key. - TikTok Integration [Import a TikTok ad account](https://docs.adlyfy.dev/import-a-tiktok-ad-account-31993869e0.md): Validates ownership of the TikTok ad account and triggers the import flow for the authenticated external user. - TikTok Integration [Read TikTok assets](https://docs.adlyfy.dev/read-tiktok-assets-31993870e0.md): Reads TikTok entities for a validated ad account owned by the authenticated external user. - TikTok Integration [Read TikTok insights](https://docs.adlyfy.dev/read-tiktok-insights-31993871e0.md): Reads TikTok reporting insights for a validated ad account owned by the authenticated external user. - TikTok Integration [Update TikTok asset status](https://docs.adlyfy.dev/update-tiktok-asset-status-31993872e0.md): Updates the status of one or more TikTok entities for a validated ad account owned by the authenticated external user. - TikTok Integration [Create or update TikTok ads payload](https://docs.adlyfy.dev/create-or-update-tiktok-ads-payload-31993873e0.md): Uses the current TikTok ads asset mutation flow for the validated ad account owned by the authenticated external user. ## Schemas - [StandardSuccessEnvelopeDto](https://docs.adlyfy.dev/standardsuccessenvelopedto-13903140d0.md): - [CreateConnectionDto](https://docs.adlyfy.dev/createconnectiondto-13241014d0.md): - [CreateLookalikeAudienceDto](https://docs.adlyfy.dev/createlookalikeaudiencedto-13241018d0.md): - [EstimateAudienceDto](https://docs.adlyfy.dev/estimateaudiencedto-13241019d0.md): - [LinkedinTenantAppCreateDto](https://docs.adlyfy.dev/linkedintenantappcreatedto-13903153d0.md): - [PreviewAdcreativeDto](https://docs.adlyfy.dev/previewadcreativedto-13241020d0.md): - [ErrorResponse](https://docs.adlyfy.dev/errorresponse-13241021d0.md): - [StandardSuccessEnvelope](https://docs.adlyfy.dev/standardsuccessenvelope-13241022d0.md): - [RawSuccessPayload](https://docs.adlyfy.dev/rawsuccesspayload-13241023d0.md): - [PaginationPageMeta](https://docs.adlyfy.dev/paginationpagemeta-13241024d0.md): - [PaginationCursorMeta](https://docs.adlyfy.dev/paginationcursormeta-13241025d0.md): - [UpdateAssetStatusRequest](https://docs.adlyfy.dev/updateassetstatusrequest-13241028d0.md): - [AccessTokenDto](https://docs.adlyfy.dev/accesstokendto-13903161d0.md): - [SearchTargetingRequest](https://docs.adlyfy.dev/searchtargetingrequest-13241029d0.md): - [AuthUrlDto](https://docs.adlyfy.dev/authurldto-13903162d0.md): - [CreatePixelRequest](https://docs.adlyfy.dev/createpixelrequest-13241030d0.md): - [PreviewRequest](https://docs.adlyfy.dev/previewrequest-13241031d0.md): - [ConnectionStatusItemDto](https://docs.adlyfy.dev/connectionstatusitemdto-13903163d0.md): - [CreateLeadFormRequest](https://docs.adlyfy.dev/createleadformrequest-13241032d0.md): - [ConnectionStatusDto](https://docs.adlyfy.dev/connectionstatusdto-13903164d0.md): - [CampaignBaseRequest](https://docs.adlyfy.dev/campaignbaserequest-13241033d0.md): - [MetaAccessTokenDto](https://docs.adlyfy.dev/metaaccesstokendto-13903165d0.md): - [CreativeBaseRequest](https://docs.adlyfy.dev/creativebaserequest-13241034d0.md): - [CreateLeadCampaignRequest](https://docs.adlyfy.dev/createleadcampaignrequest-13241035d0.md): - [CreateAwarenessCampaignRequest](https://docs.adlyfy.dev/createawarenesscampaignrequest-13241036d0.md): - [CreateEngagementCampaignRequest](https://docs.adlyfy.dev/createengagementcampaignrequest-13241037d0.md): - [TargetingSearchDto](https://docs.adlyfy.dev/targetingsearchdto-13903166d0.md): - [CreateTrafficCampaignRequest](https://docs.adlyfy.dev/createtrafficcampaignrequest-13241038d0.md): - [CreateSalesCampaignRequest](https://docs.adlyfy.dev/createsalescampaignrequest-13241039d0.md): - [MetaStatusUpdateDto](https://docs.adlyfy.dev/metastatusupdatedto-13903167d0.md): - [PaginatedUsersResponse](https://docs.adlyfy.dev/paginatedusersresponse-13241044d0.md): - [MetaCampaignTargeting](https://docs.adlyfy.dev/metacampaigntargeting-13246114d0.md):