Access to the Users API requires a secure API key with scope socialplanner/tag.readonly. Store credentials securely, rotate keys regularly, and use HTTPS for all requests.
Authorize Perfect Venue to access the Users API by exchanging OAuth tokens or API keys, using the announced scope. After consent, your app can read tags and post statistics.
1) GET /social-media-posting/:locationId/tags to fetch available tags for a location. 2) POST /social-media-posting/:locationId/tags/details to attach tag details to a post. 3) socialplanner/statistics.readonly to pull read-only analytics. 4) POST /social-media-posting/statistics to push computed statistics.
Trigger: A new post is created in Perfect Venue; fetch the location’s tags via GET /social-media-posting/:locationId/tags.
Actions: Use GET to retrieve tags, then POST /social-media-posting/:locationId/tags/details to attach tags with metadata to the post.
GET /social-media-posting/:locationId/tags
Key fields: locationId, tagName, tagDetails, timestamp
Trigger: After posting, gather statistics to track engagement.
Actions: Call GET via socialplanner/statistics.readonly to pull metrics, or POST /social-media-posting/statistics to push calculated stats.
GET /socialplanner/statistics.readonly
Key fields: locationId, metrics, timestamp
Trigger: Weekly report generation for location performance.
Actions: POST /social-media-posting/statistics with calculated values; GET /social-media-posting/:locationId/tags as needed for context.
POST /social-media-posting/statistics
Key fields: locationId, impressions, clicks, engagement, reportDate
Faster setup with drag-and-drop connectors and no custom development.
Automated tagging and statistics reduce manual work and errors.
Actionable insights inform content strategy and posting times.
Core concepts and processes you’ll encounter in the integration
Application Programming Interface: a set of rules that allows programs to communicate.
Authorization framework that lets apps access APIs securely on behalf of users.
A label you attach to a post or asset to categorize content.
A unique identifier for a physical or digital location within the platform.
Automatically fetch and apply location-based tags as campaigns launch to tailor content.
Pull statistics after each post to populate live dashboards for teams.
Use engagement data to suggest optimal posting times and tag sets.
Generate an API key with scope socialplanner/tag.readonly and store securely.
Enter the endpoint paths and authentication method in your app settings.
Run tests to verify tag retrieval and statistics posting, then enable automation.
The Users API exposes endpoints to manage social posting data and read analytics for your locations. It enables Perfect Venue to fetch and apply tags, then collect engagement statistics. This helps you tailor content and measure performance. In short, you get programmable access to your social posting workflow.
You can start with no-code/low-code automation using built-in connectors, or involve a developer for advanced custom flows. The key is to configure the correct endpoints and authentication scope, then test thoroughly.
Required permissions include read access to tags and write access for statistics where applicable. Use the provided scope socialplanner/tag.readonly for safety, and request additional scopes only as needed.
Test by creating a sample location, pulling tags with GET /social-media-posting/:locationId/tags, and posting sample statistics with POST /social-media-posting/statistics. Check logs and dashboards for accuracy.
Yes. You can map location-specific tags to each venue. Use the locationId param to scope tag retrieval and apply filters to control which tags are exposed.
Analytics are accessible in your Perfect Venue dashboard and your connected GHL statistics endpoints. You can also push metrics to external BI tools if needed.
If endpoints change, update the endpoint paths in your app configuration and re-test the connection. The integration is resilient to endpoint updates when you monitor auth scopes and rate limits.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers