Market Commentary Template v1
Information to call the Market Commentary Template v1
- API End Point:
- https://api.advicement.io/v1/templates/pub-market-commentary-v1/compile
- Authentication:
- Use your API Security Token (which is generated in your dashboard) in the Adv-Security-Token header parameter
Refer to our authentication guide for more information.
- Uses Luatex:
- FALSE
- Uses Charts:
- FALSE
- Available On:
JSON to PDF Market Commentary Template
A JSON to PDF template that creates a market commentary or news document is a tool that allows users to generate professional-looking PDF reports based on JSON data. The template defines the layout and structure of the document, while the JSON data specifies the actual content and data to be included in the report.
Use Cases for Market Commentaries
One potential use case for this tool would be in creating daily or weekly market commentary reports for financial institutions or investment firms. The JSON data could include information such as stock prices, market trends, economic indicators, and news headlines, which could be used to populate the report template. The resulting PDF report could be distributed to clients or stakeholders, providing them with up-to-date information on the state of the market.
Another use case for this tool could be in creating news summaries or digests for media companies or news organizations. The JSON data could include news articles or headlines from various sources, which could be summarized and organized using the report template. The resulting PDF document could be shared with subscribers or posted online as a daily or weekly news roundup.
A JSON to PDF template for market commentary or news documents could also be used by marketing or communications teams within companies to create internal reports or external communications. For example, a marketing team could use this tool to create a monthly report summarizing social media engagement, website traffic, and other marketing metrics. The JSON data could be pulled from various sources, such as Google Analytics, social media platforms, and email marketing software, and the resulting PDF report could be shared with stakeholders or used to inform future marketing strategies.
Key Takeaways
Overall, a JSON to PDF template for market commentary can be a versatile and powerful tool for creating customizable, professional-looking reports. By automating the design and production process, it can save time and resources while providing stakeholders with valuable information and insights.
documentSettings - A JSON object which contains the settings of the template (primaryHEXColour, secondaryHEXColour, textHEXColour, font, documentName, logo, logoType, logoWidth, margins, headSep, footSkip, showframe, header, footer).
font - An optional string which contains the font of the document. Possible options are: 'helvetica', 'avant garde', 'sans serif', 'charter', 'open sans', 'bera', 'venturis', 'raleway', 'overlock', 'roboto', 'spectral', 'clear sans', 'noto sans', 'noto mono', 'josefin', 'bera sans', 'latin modern', 'theano modern', 'droid sans', 'fira sans', 'XCharter', 'bookman', 'gyre bonum', 'gyre schola', 'gyre termes'.
fontSize - An optional integer which contains the font size of the document. Possible options are: 8, 9, 10, 11, 12, 14.
primaryHEXColour - An optional string which contains the primary font colour of the document.
secondaryHEXColour - An optional string which contains the secondary font colour of the document.
textHEXColour - An optional string which contains the text font colour of the document.
documentName - An optional string for the name of the document.
logo - An optional string which contains base64 encoded jpg or png image of your logo.
logoType - An optional string which contains the type of logo image. Possible options are: 'jpg' or 'png'.
logoWidth - An optional string which contains the width of the logo (in cm).
topMargin - An optional string containing the top margin size (in cm).
rightMargin - An optional string containing the right margin size (in cm).
bottomMargin - An optional string containing the bottom margin size (in cm).
leftMargin - An optional string containing the left margin size (in cm).
headheight - An optional string relating to the height of the header (in cm). See LaTeX geometry package documentation for more information on this parameter.
headSep - An optional string relating to the space between the header and the beginning of the document (in cm). See LaTeX geometry package documentation for more information on this parameter.
footSkip - An optional string relating to the space between the end of the document and the footer (in cm). See LaTeX geometry package documentation for more information on this parameter.
includehead - A boolean expression which determines whether the header is part of the top margin (false) or below it (true).
includehead - A boolean expression which determines whether the footer is part of the bottom margin (false) or below it (true).
showFrame - A boolean expression (true/false) to show the frame of the document.
header - An object containing settings to control the header.
headerLine - A boolean expression that generates a horizontal line between the header and the beginning of the document.
leftContent - The content that appears on the left-hand side of the header. Can contain LaTeX commands, text or simply 'logo'.
centreContent - The content that appears in the centre of the header. Can contain LaTeX commands, text or simply 'logo'.
rightContent - The content that appears of the right-hand side of the header. Can contain LaTeX commands, text or simply 'logo'.
adjustMargin - An optional string containing whether the header margin needs to be adjusted sideways (in cm).
footer - An object containing settings to control the footer.
footerLine - A boolean expression that generates a horizontal line between the footer and the end of the document.
leftContent - The content that appears on the left-hand side of the footer. Can contain LaTeX commands, text or simply 'logo'.
centreContent - The content that appears in the centre of the footer. Can contain LaTeX commands, text or simply 'logo'.
rightContent - The content that appears of the right-hand side of the footer. Can contain LaTeX commands, text or simply 'logo'.
adjustMargin - An optional string containing whether the header margin needs to be adjusted sideways (in cm).
documentContent - A JSON object which contains the content of the template (firstColumnDetails, secondColumnDetails, totalPayable, invoiceDetails, text).
body - An optional array of JSON objects which contains the body for the document.
type - A required string which contains the type of text for the body of the document. Possible options are: 'heading', 'section', 'subsection', 'paragraph', 'newpage', 'enumerate', 'itemize', 'table'.
content - A required string or array of strings which contains the text for the body of the document. Can contain LaTeX commands. Note that in an event of a table, this contains the key-name for the table.
order - A required number which determines the order of the text.