Campaigns Reference
This endpoint retrieves campaign details associated with a specific branch, identified by its branchId. The endpoint returns various details related to campaigns under that branch, such as the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, listing reference, and agent details (including their email, external ID, first and last names).
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/branch HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"branchId": "text"
}Responses for POST /api/rest/v2/campaigns/branch
{
"external_sharing_allFacebookCampaigns_campaignLevel": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}This endpoint retrieves campaign details based on a specific listing reference and branch ID. The endpoint returns various details about the campaigns, including the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, and listing reference. It also includes agent details (such as agent email, external ID, first name, and last name) and branch-related information (branch name and external branch ID). This API is useful for fetching campaigns that are tied to a specific listing and branch, allowing for precise filtering and reporting of campaign data.
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/listing HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"branchId": "text",
"listingReference": "text"
}Responses for POST /api/rest/v2/campaigns/listing
{
"campaignDetails": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}This endpoint is designed to fetch campaign details associated with a specific agent by using their email address. It takes in one parameter, agentEmail (String), which represents the email address of the agent. When provided, the endpoint returns various details related to campaigns tied to that agent, including campaign name, start and end dates, campaign type, flow campaign ID, property ID, listing reference, and agent information (such as their email, external ID, first and last names)
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/agent/email HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"agentEmail": "text"
}Responses for POST /api/rest/v2/campaigns/agent/email
{
"campaignDetails": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}This endpoint is used to retrieve campaign details associated with a specific agent based on their external agent ID. It takes a single parameter, agentExternalId (String), which is the unique external ID of the agent. The endpoint returns various campaign-related information such as the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, listing reference, and details about the agent (including email, external ID, first and last names).
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/agent/externalID HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"agentExternalId": "text"
}Responses for POST /api/rest/v2/campaigns/agent/externalID
{
"campaignDetails": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}this endpoint retrieves campaign details based on a specific external reference ID. The endpoint returns detailed information about the campaign, such as the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, listing reference, and agent details (including agent email, external ID, first and last names)
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/externalref HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"externalref": "text"
}Responses for POST /api/rest/v2/campaigns/externalref
{
"CampaignData": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}Each campaign will have analytics associated with where it originated from so that they can be associated with specific Branches, Agents, Listings and other External References. This allows relevant dashboards to link the correct campaigns to you.
This endpoint retrieves campaign details associated with a specific branch, identified by its branchId. The endpoint returns various details related to campaigns under that branch, such as the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, listing reference, and agent details (including their email, external ID, first and last names).
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/branch HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"branchId": "text"
}Responses for POST /api/rest/v2/campaigns/branch
{
"external_sharing_allFacebookCampaigns_campaignLevel": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}This endpoint retrieves campaign details based on a specific listing reference and branch ID. The endpoint returns various details about the campaigns, including the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, and listing reference. It also includes agent details (such as agent email, external ID, first name, and last name) and branch-related information (branch name and external branch ID). This API is useful for fetching campaigns that are tied to a specific listing and branch, allowing for precise filtering and reporting of campaign data.
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/listing HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"branchId": "text",
"listingReference": "text"
}Responses for POST /api/rest/v2/campaigns/listing
{
"campaignDetails": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}This endpoint is designed to fetch campaign details associated with a specific agent by using their email address. It takes in one parameter, agentEmail (String), which represents the email address of the agent. When provided, the endpoint returns various details related to campaigns tied to that agent, including campaign name, start and end dates, campaign type, flow campaign ID, property ID, listing reference, and agent information (such as their email, external ID, first and last names)
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/agent/email HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"agentEmail": "text"
}Responses for POST /api/rest/v2/campaigns/agent/email
{
"campaignDetails": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}this endpoint retrieves campaign details based on a specific external reference ID. The endpoint returns detailed information about the campaign, such as the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, listing reference, and agent details (including agent email, external ID, first and last names)
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/externalref HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"externalref": "text"
}Responses for POST /api/rest/v2/campaigns/externalref
{
"CampaignData": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}This endpoint is used to retrieve campaign details associated with a specific agent based on their external agent ID. It takes a single parameter, agentExternalId (String), which is the unique external ID of the agent. The endpoint returns various campaign-related information such as the campaign name, start and end dates, campaign type, flow campaign ID, flow property ID, listing reference, and details about the agent (including email, external ID, first and last names).
Your flow-api-user-id will be used for authentication of the API request.
Your flow-api-user-secret will be used for authentication of the API request.
POST /api/rest/v2/campaigns/agent/externalID HTTP/1.1
Host: analytics.flowliving.com
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"agentExternalId": "text"
}Responses for POST /api/rest/v2/campaigns/agent/externalID
{
"campaignDetails": [
{
"agentEmail": "text",
"agentExternalId": "text",
"agentFirstName": "text",
"agentLastName": "text",
"branchName": "text",
"campaignEndDate": null,
"campaignName": "text",
"campaignStartDate": null,
"campaignType": "text",
"externalBranchId": "text",
"flowCampaignId": "text",
"flowPropertyId": "text",
"listingReference": "text"
}
]
}Last updated