Skip to main content
Solved

API Docs

  • February 8, 2023
  • 2 replies
  • 3464 views
R
New Here

Does pigment.app have an api documentation, regarding the usage of api key .

i am looking for full api doc that will help me to understand the endpoints and using those with cURL requests

Best answer by Jennie

Hey @Raasi! 

In addition to what @Michael said, I’ve got some example cURL requests here if it helps. Replace anything between the ‘<< >>’ with your own values. 

Import API

curl --request POST 'https://pigment.app/api/importservice/Csv/ApiPush/<<import config id>>' \
--header 'X-Pigment-Api-Key: <<your API key>>' \
--header 'Content-Type: text/csv' \
--data-binary '<<CSV here>>'


Export API
Metrics and Tables

curl --request GET 'https://pigment.app/api/workspace/<<application id>>/view/ExportTableData/<<view id>>' \
--header 'X-Pigment-Api-Key: <<your API key>>'

List Data

curl --request GET 'https://pigment.app/api/workspace/<<application id>>/view/ExportListData/<<view id>>' \
--header 'X-Pigment-Api-Key: <<your API key>>'

 

nancy

2 replies

Michael
Wallflower
Forum|alt.badge.img
  • MichaelWallflower
  • Wallflower
  • February 8, 2023

Hi @Raasi 

We have various articles on using the Pigment API available: 

 

I hope this helps! :) 

francois
Keiran
Jennie
Employee
Forum|alt.badge.img+1
  • JennieEmployee
  • Employee
  • Answer
  • February 8, 2023

Hey @Raasi! 

In addition to what @Michael said, I’ve got some example cURL requests here if it helps. Replace anything between the ‘<< >>’ with your own values. 

Import API

curl --request POST 'https://pigment.app/api/importservice/Csv/ApiPush/<<import config id>>' \
--header 'X-Pigment-Api-Key: <<your API key>>' \
--header 'Content-Type: text/csv' \
--data-binary '<<CSV here>>'


Export API
Metrics and Tables

curl --request GET 'https://pigment.app/api/workspace/<<application id>>/view/ExportTableData/<<view id>>' \
--header 'X-Pigment-Api-Key: <<your API key>>'

List Data

curl --request GET 'https://pigment.app/api/workspace/<<application id>>/view/ExportListData/<<view id>>' \
--header 'X-Pigment-Api-Key: <<your API key>>'

 

KarlW
Keiran
nancy

Ask your question here!

Terms & ConditionsCookie settingsAccessibility statement